diff --git a/.gitignore b/.gitignore index 87a1ace51e09e12f655bfdb37eb3280ca2ca17c9..d58f67497c540582a67729200f77c7d83fe28d08 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,6 @@ build-tools/dts_parser/mochawesome-report #忽略本地typescript离线包 build-tools/dts_parser/deps/* + +# 忽略vscode的配置文件 +.vscode/ \ No newline at end of file diff --git a/BUILD.gn b/BUILD.gn index d347ff0abc61c3126ea58261ebf0f7920befc382..e3e1638565e5ba8091bead3c856f2973b5916eb7 100644 --- a/BUILD.gn +++ b/BUILD.gn @@ -11,20 +11,68 @@ # See the License for the specific language governing permissions and # limitations under the License. +import("//build/config/components/ets_frontend/ets2abc_config.gni") import("//build/ohos.gni") import("//build/ohos/notice/notice.gni") import("//build/ohos_var.gni") +import("//build/templates/bpf/ohos_bpf_config.gni") import("//build/templates/metadata/module_info.gni") import("interface_config.gni") # 全局变量方法见 https://gitee.com/openharmony/build/blob/master/docs/cmake%E8%BD%ACgn%E6%8C%87%E5%AF%BC%E6%96%87%E6%A1%A3.md#gn%E5%B8%B8%E7%94%A8%E7%9A%84%E5%86%85%E7%BD%AE%E5%8F%98%E9%87%8F +# 特殊场景没有拷贝interface接口信息,强基之后源码仓api不能直接使用,需要进行处理 +exists_path_tools = "//interface/sdk-js/exists_path.py" +exists_path_args = [ + "--path", + rebase_path(interface_sdk_path_ets1, root_build_dir), +] +has_interface_file = + exec_script(exists_path_tools, exists_path_args, "trim string") + +if (has_interface_file != "True") { + arkts_sdk_config_parser = "//build/ohos/sdk/parse_interface_sdk.py" + ohos_sdk_arkts_description_file = + "//out/sdk-interface/ohos_sdk_pub_description_std.json" + if (host_os == "mac") { + node_path = "//prebuilts/build-tools/common/nodejs/node-v16.20.2-darwin-x64/bin/node" + npm_path = "//prebuilts/build-tools/common/nodejs/node-v16.20.2-darwin-x64/bin/npm" + } else { + node_path = "//prebuilts/build-tools/common/nodejs/node-v16.20.2-linux-x64/bin/node" + npm_path = "//prebuilts/build-tools/common/nodejs/node-v16.20.2-linux-x64/bin/npm" + } + arkts_sdk_args = [ + "--sdk-description-file", + rebase_path("//build/ohos/sdk/ohos_sdk_description_std.json", + root_build_dir), + "--root-build-dir", + rebase_path("//", root_build_dir), + "--node-js", + rebase_path(node_path, root_build_dir), + "--output-arkts-sdk-desc-file", + rebase_path(ohos_sdk_arkts_description_file, root_build_dir), + "--sdk-build-public", + "${sdk_build_public}", + "--sdk-build-arkts", + "${sdk_build_arkts}", + "--npm-path", + rebase_path(npm_path, root_build_dir), + ] + exec_script(arkts_sdk_config_parser, arkts_sdk_args) +} + template("ohos_copy_internal") { forward_variables_from(invoker, "*") iv_input = invoker.iv_input + # fullSDK中api路径 + input_project_dir = interface_sdk_path_ets1 + if (sdk_type == "ets2") { + input_project_dir = interface_sdk_path_ets2 + } + # 调用build/templates/common/copy.gni中的ohos_copy方法 - # 将处理完成的文件输出到中间产物对应位置 out/sdk/obj/interface/sdk-js/$target_name + # 将处理完成的文件输出到中间产物对应位置 out/sdk/obj/interface/sdk-js/${target_name} ohos_copy(target_name) { # 该脚本根据传入的remove文件进行input文件规则检查,过滤不需要的文件 # remove文件没有对应$target_name的属性 则全部输出 @@ -35,18 +83,23 @@ template("ohos_copy_internal") { process_arguments = [ "--input", rebase_path(iv_input, root_build_dir), + "--project-dir", + rebase_path(input_project_dir, root_build_dir), + "--base-dir", + rebase_path("//interface/sdk-js", root_build_dir), "--remove", rebase_path("//interface/sdk-js/remove_list.json", root_build_dir), "--ispublic", "${sdk_build_public}", "--name", - "$target_name", + "${target_name}", ] # 执行脚本 sources = exec_script(process_script, process_arguments, "value") - outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] - module_source_dir = target_out_dir + "/$target_name" + outputs = + [ target_out_dir + "/${sdk_type}/${target_name}/{{source_file_part}}" ] + module_source_dir = target_out_dir + "/${sdk_type}/${target_name}" module_install_name = "" } } @@ -54,29 +107,28 @@ template("ohos_copy_internal") { # 主要api处理template template("ohos_declaration_template") { forward_variables_from(invoker, "*") - _module_info_target = "/ohos_declaration/${target_name}_info" + _module_info_target = "/ohos_declaration/${sdk_type}/${target_name}_info" + + # fullSDK中api路径 + input_project_dir = interface_sdk_path_ets1 + if (sdk_type == "ets2") { + input_project_dir = interface_sdk_path_ets2 + } + input_api_dir = input_project_dir + "/api" action_with_pydeps(target_name) { - inputs = [ "//interface/sdk-js/api" ] - outputs = [ root_out_dir + "/ohos_declaration/$target_name" ] + inputs = [ input_project_dir + "/api" ] + outputs = [ root_out_dir + "/ohos_declaration/${sdk_type}/${target_name}" ] # 处理api文件下全部文件,过滤特定文件 script = "//interface/sdk-js/remove_internal.py" - - # fullSDK中api路径 - input_api_dir = "//interface/sdk-js/api" - if (sdk_build_public || product_name == "ohos-sdk") { - script = "//out/sdk-public/public_interface/sdk-js/remove_internal.py" - - # publicSDK中api路径,经过./build-tools/delete_systemapi_plugin.js脚本处理过systemapi的接口 - input_api_dir = "//out/sdk-public/public_interface/sdk-js/api" - } args = [ "--input", rebase_path(input_api_dir, root_build_dir), "--output", - rebase_path(root_out_dir + "/ohos_declaration/$target_name/", - root_build_dir), + rebase_path( + root_out_dir + "/ohos_declaration/${sdk_type}/${target_name}/", + root_build_dir), ] if (defined(deps)) { deps += [ ":$_module_info_target" ] @@ -89,76 +141,94 @@ template("ohos_declaration_template") { module_type = "jsdoc" module_install_name = "" module_name = _target_name - module_source_dir = root_out_dir + "/ohos_declaration/$_target_name" + module_source_dir = + root_out_dir + "/ohos_declaration/${sdk_type}/$_target_name" install_enable = false } } # ets/api执行脚本 ohos_declaration_template("ohos_declaration_ets") { + sdk_type = "ets" } -# ets/api执行脚本 -ohos_copy("common_api") { - sources = common_api_src - outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] - module_source_dir = target_out_dir + "/$target_name" - module_install_name = "" +# ets2/api执行脚本 +ohos_declaration_template("ohos_declaration_ets2") { + sdk_type = "ets2" } # ets/api/@internal/full执行脚本 ohos_copy_internal("ets_internal_api") { - iv_input = "//interface/sdk-js/api/@internal/ets" + sdk_type = "ets" + iv_input = interface_sdk_path_ets1 + "/api/@internal/ets" } # ets/arkts执行脚本 -ohos_copy("bundle_arkts") { - sources = [ "//interface/sdk-js/arkts" ] - outputs = [ target_out_dir + "/$target_name" ] - module_source_dir = target_out_dir + "/$target_name" - module_install_name = "" - license_file = "./LICENCE.md" +ohos_copy_internal("bundle_arkts") { + sdk_type = "ets" + iv_input = interface_sdk_path_ets1 + "/arkts" +} + +# ets1.2/arkts执行脚本 +ohos_copy_internal("bundle_arkts_ets1.2") { + sdk_type = "ets2" + iv_input = interface_sdk_path_ets2 + "/arkts" +} + +ohos_copy_internal("ets_internal_api2") { + sdk_type = "ets2" + iv_input = interface_sdk_path_ets2 + "/api/@internal/ets" } if (!sdk_build_public) { # ets/build-tools/ets-loader/declarations脚本 ohos_copy("bundle_api") { + sdk_type = "ets" sources = [ "api/bundle/bundleStatusCallback.d.ts" ] - outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] - module_source_dir = target_out_dir + "/$target_name" + outputs = + [ target_out_dir + "/${sdk_type}/${target_name}/{{source_file_part}}" ] + module_source_dir = target_out_dir + "/${sdk_type}/${target_name}" module_install_name = "" } } # ets/component执行脚本 ohos_copy_internal("ets_component") { - iv_input = "//interface/sdk-js/api/@internal/component/ets" + sdk_type = "ets" + iv_input = interface_sdk_path_ets1 + "/api/@internal/component/ets" +} + +# ets1.2/arkui/component执行脚本 +ohos_copy_internal("ets_component2") { + sdk_type = "ets2" + iv_input = "//out/arkui_transformer_api" } # ets/kits执行脚本 -ohos_copy("bundle_kits") { - if (sdk_build_public || product_name == "ohos-sdk") { - sources = [ "//out/sdk-public/public_interface/sdk-js/kits" ] - } else { - sources = [ "//interface/sdk-js/kits" ] - } - outputs = [ target_out_dir + "/$target_name" ] - module_source_dir = target_out_dir + "/$target_name" - module_install_name = "" +ohos_copy_internal("bundle_kits") { + sdk_type = "ets" + iv_input = interface_sdk_path_ets1 + "/kits" +} + +# ets2/kits执行脚本 +ohos_copy_internal("bundle_kits2") { + sdk_type = "ets2" + iv_input = interface_sdk_path_ets2 + "/kits" } # js/api执行脚本 ohos_declaration_template("ohos_declaration_common") { + sdk_type = "ets" } # js/api/@internal/full执行脚本 ohos_copy_internal("internal_full") { - iv_input = "//interface/sdk-js/api/common/full" + iv_input = interface_sdk_path_ets1 + "/api/common/full" } # js/api/@internal/lite执行脚本呢 ohos_copy_internal("internal_lite") { - iv_input = "//interface/sdk-js/api/common/lite" + iv_input = interface_sdk_path_ets1 + "/api/common/lite" } # js/api/config执行脚本 @@ -167,8 +237,8 @@ ohos_copy("config") { "api/config/css", "api/config/hml", ] - outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] - module_source_dir = target_out_dir + "/$target_name" + outputs = [ target_out_dir + "/${target_name}/{{source_file_part}}" ] + module_source_dir = target_out_dir + "/${target_name}" module_install_name = "" } @@ -179,15 +249,129 @@ ohos_copy("form_declaration") { "api/form/css", "api/form/hml", ] - outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] - module_source_dir = target_out_dir + "/$target_name" + outputs = [ target_out_dir + "/${target_name}/{{source_file_part}}" ] + module_source_dir = target_out_dir + "/${target_name}" module_install_name = "" } # toolchains/syscapcheck执行脚本 ohos_copy("syscap_check") { sources = [ "api/syscapCheck/sysCapSchema.json" ] - outputs = [ target_out_dir + "/$target_name/{{source_file_part}}" ] - module_source_dir = target_out_dir + "/$target_name" + outputs = [ target_out_dir + "/${target_name}/{{source_file_part}}" ] + module_source_dir = target_out_dir + "/${target_name}" module_install_name = "" } + +action("ohos_ets_api_tmp") { + script = "//interface/sdk-js/ohos_copy_ets.py" + + args = [ + "--input", + rebase_path("//interface/sdk-js/api"), + "--output", + rebase_path("$ohos_ets_api_tmp_path"), + "--type", + "ets2", + "--source-root-dir", + rebase_path("//"), + "--node-js", + rebase_path(nodejs, root_build_dir), + ] + + outputs = [ "$ohos_ets_api_tmp_path" ] +} + +action("ohos_ets_arkts_tmp") { + script = "//interface/sdk-js/ohos_copy_ets.py" + + args = [ + "--input", + rebase_path("//interface/sdk-js/arkts"), + "--output", + rebase_path("$ohos_ets_arkts_tmp_path"), + "--type", + "ets2", + "--source-root-dir", + rebase_path("//"), + "--node-js", + rebase_path(nodejs, root_build_dir), + ] + + outputs = [ "$ohos_ets_arkts_tmp_path" ] +} + +action("ohos_ets_kits_tmp") { + script = "//interface/sdk-js/ohos_copy_ets.py" + + args = [ + "--input", + rebase_path("//interface/sdk-js/kits"), + "--output", + rebase_path("$ohos_ets_kits_tmp_path"), + "--type", + "ets2", + "--source-root-dir", + rebase_path("//"), + "--node-js", + rebase_path(nodejs, root_build_dir), + ] + + outputs = [ "$ohos_ets_kits_tmp_path" ] +} + +action("ohos_ets_api_arkui_tmp") { + deps = [ ":ohos_ets_api_tmp" ] + script = "//interface/sdk-js/arkui_transformer.py" + + if (host_os == "mac") { + node_path = "//prebuilts/build-tools/common/nodejs/node-v16.20.2-darwin-x64/bin/node" + npm_path = + "//prebuilts/build-tools/common/nodejs/node-v16.20.2-darwin-x64/bin/npm" + } else { + node_path = + "//prebuilts/build-tools/common/nodejs/node-v16.20.2-linux-x64/bin/node" + npm_path = + "//prebuilts/build-tools/common/nodejs/node-v16.20.2-linux-x64/bin/npm" + } + args = [ + "--input", + rebase_path(ohos_ets_api_tmp_path + "/@internal/component/ets", + root_build_dir), + "--output", + rebase_path(ohos_ets_api_tmp_path + "/arkui/component", root_build_dir), + "--source_root_dir", + rebase_path("//", root_build_dir), + "--npm-path", + rebase_path(npm_path, root_build_dir), + "--node-js", + rebase_path(node_path, root_build_dir), + ] + outputs = [ "$ohos_ets_api_arkui_tmp_path" ] +} + +ohos_copy("ohos_ets_arkts") { + deps = [ ":ohos_ets_arkts_tmp" ] + sources = [ ohos_ets_arkts_tmp_path ] + outputs = [ ohos_ets_arkts_path ] + part_name = "sdk" + subsystem_name = "sdk" +} + +ohos_copy("ohos_ets_kits") { + deps = [ ":ohos_ets_kits_tmp" ] + sources = [ ohos_ets_kits_tmp_path ] + outputs = [ ohos_ets_kits_path ] + part_name = "sdk" + subsystem_name = "sdk" +} + +ohos_copy("ohos_ets_api") { + deps = [ + ":ohos_ets_api_arkui_tmp", + ":ohos_ets_api_tmp", + ] + sources = [ ohos_ets_api_tmp_path ] + outputs = [ ohos_ets_api_path ] + part_name = "sdk" + subsystem_name = "sdk" +} diff --git a/OAT.xml b/OAT.xml index 2ec3b5633794929f80ae462e639c48d22876e1ec..c3931061183e0fd0f53acbf4837b9a9681017b46 100644 --- a/OAT.xml +++ b/OAT.xml @@ -86,6 +86,12 @@ Note:If the text contains special characters, please escape them according to th + + + + + + diff --git a/api/@internal/component/ets/action_sheet.d.ts b/api/@internal/component/ets/action_sheet.d.ts index 3f404fc1b2c0d3d518dff90d9ea4c39c1e511e0a..166a48deb4de82564c0acfe9c66609dac60f0810 100644 --- a/api/@internal/component/ets/action_sheet.d.ts +++ b/api/@internal/component/ets/action_sheet.d.ts @@ -18,6 +18,19 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource'; +import { + VoidCallback, ResourceStr, ResourceColor, Dimension, BorderRadiuses, LocalizedEdgeColors, EdgeColors, + EdgeWidths, LocalizedEdgeWidths, EdgeStyles, LocalizedBorderRadiuses +} from './units'; +import { Callback, DismissReason, Rectangle, BlurStyle, TransitionEffect, ShadowOptions, HoverModeAreaType, + ShadowStyle, BackgroundBlurStyleOptions, BackgroundEffectOptions } from './common'; +import { DialogButtonStyle, BorderStyle } from './enums'; +import { DialogAlignment } from './alertDialog'; +import { LevelOrder, LevelMode, ImmersiveMode } from '../../@ohos.promptAction'; +/*** endif */ + /** * The information of sheet. * @@ -40,7 +53,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SheetInfo { /** @@ -65,7 +79,8 @@ interface SheetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title: string | Resource; @@ -91,7 +106,8 @@ interface SheetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: string | Resource; @@ -126,7 +142,8 @@ interface SheetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ action: VoidCallback; } @@ -138,7 +155,8 @@ interface SheetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DismissDialogAction { /** @@ -148,7 +166,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dismiss: Callback; @@ -159,7 +178,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reason: DismissReason; } @@ -171,7 +191,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface ActionSheetButtonOptions { /** @@ -189,7 +210,8 @@ interface ActionSheetButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enabled?: boolean; @@ -208,7 +230,8 @@ interface ActionSheetButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ defaultFocus?: boolean; @@ -227,7 +250,8 @@ interface ActionSheetButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: DialogButtonStyle; @@ -253,7 +277,8 @@ interface ActionSheetButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: string | Resource; @@ -288,7 +313,8 @@ interface ActionSheetButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ action: VoidCallback; } @@ -300,7 +326,8 @@ interface ActionSheetButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface ActionSheetOffset { /** @@ -310,7 +337,8 @@ interface ActionSheetOffset { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ dx: number | string | Resource; /** @@ -320,7 +348,8 @@ interface ActionSheetOffset { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ dy: number | string | Resource; } @@ -369,7 +398,8 @@ declare type ImmersiveMode = import('../api/@ohos.promptAction').ImmersiveMode; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ActionSheetOptions { @@ -395,7 +425,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title: string | Resource; @@ -412,7 +443,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ subtitle?: ResourceStr; @@ -438,7 +470,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ message: string | Resource; @@ -473,7 +506,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ confirm?: ActionSheetButtonOptions; @@ -508,7 +542,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ cancel?: VoidCallback; @@ -534,7 +569,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sheets: Array; @@ -560,7 +596,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ autoCancel?: boolean; @@ -586,7 +623,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: DialogAlignment; @@ -621,7 +659,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: ActionSheetOffset; @@ -640,7 +679,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskRect?: Rectangle; @@ -661,7 +701,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -680,7 +721,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isModal?: boolean; @@ -701,7 +743,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -722,7 +765,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -733,7 +777,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -744,7 +789,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -755,7 +801,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: Callback; @@ -766,7 +813,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -777,7 +825,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cornerRadius?: Dimension | BorderRadiuses | LocalizedBorderRadiuses; @@ -788,7 +837,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -799,7 +849,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height?: Dimension; @@ -810,7 +861,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; @@ -821,7 +873,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; @@ -832,7 +885,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderStyle?: BorderStyle | EdgeStyles; @@ -843,7 +897,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -855,7 +910,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -867,7 +923,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -878,7 +935,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: Callback; @@ -889,7 +947,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: Callback; @@ -900,7 +959,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: Callback; @@ -911,7 +971,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: Callback; @@ -923,7 +984,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ levelMode?: LevelMode; @@ -934,7 +996,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ levelUniqueId?: number; @@ -946,7 +1009,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ immersiveMode?: ImmersiveMode; @@ -958,7 +1022,8 @@ interface ActionSheetOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ levelOrder?: LevelOrder; } diff --git a/api/@internal/component/ets/alert_dialog.d.ts b/api/@internal/component/ets/alert_dialog.d.ts index 313499a3e3c02d16e527db5466377665d732dcfa..047b8a9242a5ef7314c384e865cfde8378b3de90 100644 --- a/api/@internal/component/ets/alert_dialog.d.ts +++ b/api/@internal/component/ets/alert_dialog.d.ts @@ -18,6 +18,17 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { + ResourceStr, ResourceColor, VoidCallback, Offset, Dimension, BorderRadiuses, LocalizedBorderRadiuses, EdgeWidths, + LocalizedEdgeWidths, EdgeColors, LocalizedEdgeColors, EdgeStyles +} from './units'; +import { WordBreak, DialogButtonStyle, BorderStyle } from './enums'; +import { Rectangle, BlurStyle, Callback, TransitionEffect, ShadowOptions, ShadowStyle, HoverModeAreaType, DismissReason, + BackgroundBlurStyleOptions, BackgroundEffectOptions } from './common'; +import { LevelOrder, ImmersiveMode, LevelMode } from '../../@ohos.promptAction'; +/*** endif */ + /** * The alignment of dialog, * @@ -40,7 +51,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DialogAlignment { /** @@ -62,7 +74,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -85,7 +98,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -108,7 +122,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, @@ -131,7 +146,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Default, @@ -154,7 +170,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TopStart, @@ -177,7 +194,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TopEnd, @@ -200,7 +218,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CenterStart, @@ -223,7 +242,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CenterEnd, @@ -246,7 +266,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BottomStart, @@ -269,7 +290,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BottomEnd, } @@ -289,7 +311,8 @@ declare enum DialogAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice -* @since 11 +* @since arkts {'1.1':'11','1.2':'20'} +* @arkts 1.1&1.2 */ declare enum DialogButtonDirection { /** @@ -305,7 +328,8 @@ declare enum DialogButtonDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -322,7 +346,8 @@ declare enum DialogButtonDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HORIZONTAL = 1, @@ -339,7 +364,8 @@ declare enum DialogButtonDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ VERTICAL = 2, } @@ -351,7 +377,8 @@ declare enum DialogButtonDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AlertDialogButtonBaseOptions { /** @@ -371,7 +398,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enabled?: boolean; @@ -392,7 +420,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ defaultFocus?: boolean; @@ -413,7 +442,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: DialogButtonStyle; @@ -432,7 +462,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: ResourceStr; @@ -451,7 +482,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; @@ -470,7 +502,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -498,7 +531,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ action: VoidCallback; } @@ -530,7 +564,8 @@ declare interface AlertDialogButtonBaseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AlertDialogButtonOptions extends AlertDialogButtonBaseOptions { /** @@ -540,7 +575,8 @@ declare interface AlertDialogButtonOptions extends AlertDialogButtonBaseOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ primary?: boolean; } @@ -552,7 +588,8 @@ declare interface AlertDialogButtonOptions extends AlertDialogButtonBaseOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextStyle { /** @@ -562,7 +599,8 @@ declare interface TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak?: WordBreak; } @@ -600,7 +638,8 @@ declare type LevelOrder = import('../api/@ohos.promptAction').LevelOrder; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AlertDialogParam { /** @@ -625,7 +664,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title?: ResourceStr; @@ -642,7 +682,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ subtitle?: ResourceStr; @@ -668,7 +709,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ message: ResourceStr; @@ -694,7 +736,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ autoCancel?: boolean; @@ -729,7 +772,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ cancel?: VoidCallback; @@ -755,7 +799,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: DialogAlignment; @@ -781,7 +826,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Offset; @@ -807,7 +853,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ gridCount?: number; @@ -826,7 +873,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskRect?: Rectangle; @@ -847,7 +895,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -866,7 +915,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isModal?: boolean; @@ -887,7 +937,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -908,7 +959,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -919,7 +971,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -930,7 +983,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -941,7 +995,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: Callback; @@ -952,7 +1007,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -963,7 +1019,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cornerRadius?: Dimension | BorderRadiuses | LocalizedBorderRadiuses; @@ -974,7 +1031,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -985,7 +1043,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height?: Dimension; @@ -996,7 +1055,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; @@ -1007,7 +1067,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; @@ -1018,7 +1079,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderStyle?: BorderStyle | EdgeStyles; @@ -1029,7 +1091,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -1040,7 +1103,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle?: TextStyle; @@ -1052,7 +1116,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -1064,7 +1129,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -1075,7 +1141,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: Callback; @@ -1086,7 +1153,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: Callback; @@ -1097,7 +1165,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: Callback; @@ -1108,7 +1177,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: Callback; @@ -1120,7 +1190,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ levelMode?: LevelMode; @@ -1131,7 +1202,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ levelUniqueId?: number; @@ -1143,7 +1215,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ immersiveMode?: ImmersiveMode; @@ -1155,7 +1228,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ levelOrder?: LevelOrder; } @@ -1185,7 +1259,8 @@ declare interface AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AlertDialogParamWithConfirm extends AlertDialogParam { /** @@ -1219,7 +1294,8 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ confirm?: AlertDialogButtonBaseOptions; } @@ -1231,7 +1307,8 @@ declare interface AlertDialogParamWithConfirm extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DismissDialogAction { /** @@ -1241,7 +1318,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dismiss: Callback; @@ -1252,7 +1330,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reason: DismissReason; } @@ -1282,7 +1361,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AlertDialogParamWithButtons extends AlertDialogParam { /** @@ -1316,7 +1396,8 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ primaryButton: AlertDialogButtonBaseOptions; @@ -1351,7 +1432,8 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ secondaryButton: AlertDialogButtonBaseOptions; } @@ -1373,7 +1455,8 @@ declare interface AlertDialogParamWithButtons extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AlertDialogParamWithOptions extends AlertDialogParam { /** @@ -1389,7 +1472,8 @@ declare interface AlertDialogParamWithOptions extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ buttons: Array; @@ -1408,7 +1492,8 @@ declare interface AlertDialogParamWithOptions extends AlertDialogParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ buttonDirection?: DialogButtonDirection; } diff --git a/api/@internal/component/ets/alphabet_indexer.d.ts b/api/@internal/component/ets/alphabet_indexer.d.ts index 46a27282cbdcd4c7c115ce73dd1ee562bc781ea4..c8003ca0f0be75d294e08c124364542d15b80cf6 100644 --- a/api/@internal/component/ets/alphabet_indexer.d.ts +++ b/api/@internal/component/ets/alphabet_indexer.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, BlurStyle } from './common' +import { ResourceColor, Length, Position } from './units' +import { Font } from './units' +/*** endif */ + /** * indexer align property. * @@ -40,7 +46,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum IndexerAlign { /** @@ -62,7 +69,8 @@ declare enum IndexerAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, @@ -85,7 +93,8 @@ declare enum IndexerAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -95,7 +104,8 @@ declare enum IndexerAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START, @@ -105,7 +115,8 @@ declare enum IndexerAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END, } @@ -117,7 +128,8 @@ declare enum IndexerAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface AlphabetIndexerOptions { /** @@ -142,7 +154,8 @@ interface AlphabetIndexerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrayValue: Array; /** @@ -167,7 +180,8 @@ interface AlphabetIndexerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selected: number; } @@ -194,7 +208,8 @@ interface AlphabetIndexerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface AlphabetIndexerInterface { /** @@ -236,7 +251,8 @@ interface AlphabetIndexerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options: AlphabetIndexerOptions): AlphabetIndexerAttribute; } @@ -249,7 +265,8 @@ interface AlphabetIndexerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnAlphabetIndexerSelectCallback = (index: number) => void; @@ -261,7 +278,8 @@ declare type OnAlphabetIndexerSelectCallback = (index: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnAlphabetIndexerPopupSelectCallback = (index: number) => void; @@ -274,7 +292,8 @@ declare type OnAlphabetIndexerPopupSelectCallback = (index: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnAlphabetIndexerRequestPopupDataCallback = (index: number) => Array; @@ -300,7 +319,8 @@ declare type OnAlphabetIndexerRequestPopupDataCallback = (index: number) => Arra * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class AlphabetIndexerAttribute extends CommonMethod { /** @@ -340,7 +360,8 @@ declare class AlphabetIndexerAttribute extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ declare class AnimatorAttribute extends CommonMethod { /** @@ -142,7 +156,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ state(value: AnimationStatus): AnimatorAttribute; @@ -153,7 +168,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ duration(value: number): AnimatorAttribute; @@ -164,7 +180,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ curve(value: Curve): AnimatorAttribute; @@ -175,7 +192,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ delay(value: number): AnimatorAttribute; @@ -186,7 +204,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ fillMode(value: FillMode): AnimatorAttribute; @@ -197,7 +216,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ iterations(value: number): AnimatorAttribute; @@ -208,7 +228,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ playMode(value: PlayMode): AnimatorAttribute; @@ -219,7 +240,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ motion(value: SpringMotion | FrictionMotion | ScrollMotion): AnimatorAttribute; @@ -230,7 +252,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ onStart(event: () => void): AnimatorAttribute; @@ -241,7 +264,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ onPause(event: () => void): AnimatorAttribute; @@ -252,7 +276,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ onRepeat(event: () => void): AnimatorAttribute; @@ -263,7 +288,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ onCancel(event: () => void): AnimatorAttribute; @@ -274,7 +300,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish(event: () => void): AnimatorAttribute; @@ -285,7 +312,8 @@ declare class AnimatorAttribute extends CommonMethod { * @returns { AnimatorAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ onFrame(event: (value: number) => void): AnimatorAttribute; } diff --git a/api/@internal/component/ets/badge.d.ts b/api/@internal/component/ets/badge.d.ts index 367a4b1082b7449bd68d838cc60d078c35f55616..86f5aedcca6fec0a9787868a42b63d46506f6b23 100644 --- a/api/@internal/component/ets/badge.d.ts +++ b/api/@internal/component/ets/badge.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor, Length, Position, Resource, ResourceStr } from './units'; +import { FontWeight } from './enums'; +import { CommonMethod } from './common'; +/*** endif */ + /** * Defines the badge position property. * @@ -50,7 +56,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BadgePosition { /** @@ -81,7 +88,8 @@ declare enum BadgePosition { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RightTop, @@ -113,7 +121,8 @@ declare enum BadgePosition { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -145,7 +154,8 @@ declare enum BadgePosition { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, } @@ -182,7 +192,8 @@ declare enum BadgePosition { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BadgeStyle { /** @@ -217,7 +228,8 @@ declare interface BadgeStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -255,7 +267,18 @@ declare interface BadgeStyle { * @atomicservice * @since 11 */ - fontSize?: number | string; + /** + * Text size. + * + * @type { ?(number | ResourceStr) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + fontSize?: number | ResourceStr; /** * Size of a badge. @@ -291,7 +314,18 @@ declare interface BadgeStyle { * @atomicservice * @since 11 */ - badgeSize?: number | string; + /** + * Size of a badge. + * + * @type { ?(number | ResourceStr) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + badgeSize?: number | ResourceStr; /** * Color of the badge. @@ -325,7 +359,8 @@ declare interface BadgeStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ badgeColor?: ResourceColor; @@ -344,7 +379,8 @@ declare interface BadgeStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor?: ResourceColor; @@ -363,7 +399,8 @@ declare interface BadgeStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth?: Length; @@ -384,7 +421,17 @@ declare interface BadgeStyle { * @atomicservice * @since 11 */ - fontWeight?: number | FontWeight | string; + /** + * Define the font weight of the badge. + * + * @type { ?(number | FontWeight | ResourceStr) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + fontWeight?: number | FontWeight | ResourceStr; } /** @@ -419,7 +466,8 @@ declare interface BadgeStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BadgeParam { /** @@ -454,7 +502,8 @@ declare interface BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ position?: BadgePosition | Position; @@ -490,7 +539,8 @@ declare interface BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style: BadgeStyle; } @@ -531,7 +581,8 @@ declare interface BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BadgeParamWithNumber extends BadgeParam { /** @@ -566,7 +617,8 @@ declare interface BadgeParamWithNumber extends BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ count: number; @@ -602,7 +654,8 @@ declare interface BadgeParamWithNumber extends BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxCount?: number; } @@ -643,7 +696,8 @@ declare interface BadgeParamWithNumber extends BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BadgeParamWithString extends BadgeParam { /** @@ -680,7 +734,18 @@ declare interface BadgeParamWithString extends BadgeParam { * @atomicservice * @since 11 */ - value: string; + /** + * Text string of the prompt content. + * + * @type { ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + value: ResourceStr; } /** @@ -715,7 +780,8 @@ declare interface BadgeParamWithString extends BadgeParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface BadgeInterface { /** @@ -766,7 +832,8 @@ interface BadgeInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: BadgeParamWithNumber): BadgeAttribute; @@ -818,7 +885,8 @@ interface BadgeInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: BadgeParamWithString): BadgeAttribute; } @@ -855,9 +923,10 @@ interface BadgeInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare class BadgeAttribute extends CommonMethod {} +declare class BadgeAttribute extends CommonMethod { } /** * Defines Badge Component. @@ -922,3 +991,29 @@ declare const Badge: BadgeInterface; * @since 11 */ declare const BadgeInstance: BadgeAttribute; + +/** + * Define BadgeParamWithString's property 'value' type + * + * @typedef { string | Resource } BadgeParamWithStringType + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ +declare type BadgeParamWithStringType = string | Resource; + +/** + * Define BadgeStyle's size-relative properties type + * + * @typedef { number | string | Resource } BadgeStyleSizeType + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ +declare type BadgeStyleSizeType = number | string | Resource; \ No newline at end of file diff --git a/api/@internal/component/ets/blank.d.ts b/api/@internal/component/ets/blank.d.ts index 9f7182728f048faa8ecb67c34736d72643d96ee6..80958fccc971168677c02058b968d180706aaa06 100644 --- a/api/@internal/component/ets/blank.d.ts +++ b/api/@internal/component/ets/blank.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +import { ResourceColor } from './units'; +/*** endif */ + /** * Create Blank. * @@ -50,7 +55,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface BlankInterface { /** @@ -89,7 +95,8 @@ interface BlankInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (min?: number | string): BlankAttribute; } @@ -126,7 +133,8 @@ interface BlankInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class BlankAttribute extends CommonMethod { /** @@ -165,7 +173,8 @@ declare class BlankAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color(value: ResourceColor): BlankAttribute; } diff --git a/api/@internal/component/ets/button.d.ts b/api/@internal/component/ets/button.d.ts index 31894becbee97034c3ebae2ea3eb69aff129920a..0521566975c78e498e23b7822f45931b30495332 100644 --- a/api/@internal/component/ets/button.d.ts +++ b/api/@internal/component/ets/button.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource'; +import { ResourceStr, ResourceColor, Length, Font } from './units'; +import { TextOverflow, FontWeight, FontStyle, TextHeightAdaptivePolicy } from './enums'; +import { CommonConfiguration, CommonMethod, ContentModifier } from './common'; +/*** endif */ + /** * Provides a button component. * @@ -50,7 +57,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ButtonType { /** @@ -81,7 +89,8 @@ declare enum ButtonType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Capsule, @@ -113,7 +122,8 @@ declare enum ButtonType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Circle, @@ -145,7 +155,8 @@ declare enum ButtonType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -156,7 +167,8 @@ declare enum ButtonType { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ROUNDED_RECTANGLE = 3, } @@ -178,7 +190,8 @@ declare enum ButtonType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ButtonStyleMode { /** @@ -196,7 +209,8 @@ declare enum ButtonStyleMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, @@ -215,7 +229,8 @@ declare enum ButtonStyleMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMPHASIZED = 1, @@ -234,7 +249,8 @@ declare enum ButtonStyleMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TEXTUAL = 2, } @@ -247,7 +263,8 @@ declare enum ButtonStyleMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ButtonRole { /** @@ -257,7 +274,8 @@ declare enum ButtonRole { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, @@ -268,7 +286,8 @@ declare enum ButtonRole { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ERROR = 1, } @@ -282,7 +301,8 @@ declare enum ButtonRole { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ButtonTriggerClickCallback = (xPos: number, yPos: number) => void; @@ -294,7 +314,8 @@ declare type ButtonTriggerClickCallback = (xPos: number, yPos: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ButtonConfiguration extends CommonConfiguration { @@ -305,7 +326,8 @@ declare interface ButtonConfiguration extends CommonConfiguration { /** @@ -918,7 +1040,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type(value: ButtonType): ButtonAttribute; @@ -958,7 +1081,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stateEffect(value: boolean): ButtonAttribute; @@ -981,7 +1105,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ buttonStyle(value: ButtonStyleMode): ButtonAttribute; @@ -1004,7 +1129,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ controlSize(value: ControlSize): ButtonAttribute; @@ -1017,7 +1143,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ role(value: ButtonRole): ButtonAttribute; @@ -1057,7 +1184,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): ButtonAttribute; @@ -1097,7 +1225,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Length): ButtonAttribute; @@ -1137,7 +1266,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): ButtonAttribute; @@ -1177,7 +1307,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): ButtonAttribute; @@ -1217,7 +1348,8 @@ declare class ButtonAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: string | Resource): ButtonAttribute; @@ -1229,7 +1361,8 @@ declare class ButtonAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): ButtonAttribute; @@ -1254,6 +1387,19 @@ declare class ButtonAttribute extends CommonMethod { */ labelStyle(value: LabelStyle): ButtonAttribute; + /** + * Set button label style. + * + * @param { ButtonLabelStyle } value - The label style configuration on button. + * @returns { ButtonAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + labelStyle(value: ButtonLabelStyle): ButtonAttribute; + /** * Sets the minimum zoom-out ratio of the button text. * @@ -1261,7 +1407,8 @@ declare class ButtonAttribute extends CommonMethod { * @returns { ButtonAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: number | Resource): ButtonAttribute; @@ -1272,7 +1419,8 @@ declare class ButtonAttribute extends CommonMethod { * @returns { ButtonAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: number | Resource): ButtonAttribute; } diff --git a/api/@internal/component/ets/calendar.d.ts b/api/@internal/component/ets/calendar.d.ts index ecac65717c5fb55fb559f20f98b5ff8e78ce7ef9..90c32e3def4147ffe69efca6bf740d770e8d4fc9 100644 --- a/api/@internal/component/ets/calendar.d.ts +++ b/api/@internal/component/ets/calendar.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor } from './units' +import { Axis } from './enums' +/*** endif */ + /** * Provides a monthly view component to display information such as date, shift break, and schedule. * @@ -33,7 +38,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface CalendarDay { /** @@ -53,7 +59,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -74,7 +81,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ lunarMonth: string; @@ -93,7 +101,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ lunarDay: string; @@ -112,7 +121,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayMark: string; @@ -131,7 +141,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayMarkValue: string; @@ -150,7 +161,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ year: number; @@ -169,7 +181,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ month: number; @@ -188,7 +201,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ day: number; @@ -207,7 +221,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ isFirstOfLunar: boolean; @@ -228,7 +243,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ hasSchedule: boolean; @@ -247,7 +263,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ markLunarDay: boolean; } @@ -267,7 +284,8 @@ interface CalendarDay { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface MonthData { /** @@ -285,7 +303,8 @@ interface MonthData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ year: number; @@ -304,7 +323,8 @@ interface MonthData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ month: number; @@ -323,7 +343,8 @@ interface MonthData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ data: CalendarDay[]; } @@ -343,7 +364,8 @@ interface MonthData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface CurrentDayStyle { /** @@ -361,7 +383,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayColor?: ResourceColor; @@ -380,7 +403,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ lunarColor?: ResourceColor; @@ -399,7 +423,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ markLunarColor?: ResourceColor; @@ -418,7 +443,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayFontSize?: number; @@ -437,7 +463,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ lunarDayFontSize?: number; @@ -456,7 +483,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayHeight?: number; @@ -475,7 +503,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayWidth?: number; @@ -494,7 +523,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ gregorianCalendarHeight?: number; @@ -513,7 +543,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dayYAxisOffset?: number; @@ -532,7 +563,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ lunarDayYAxisOffset?: number; @@ -551,7 +583,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ underscoreXAxisOffset?: number; @@ -570,7 +603,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ underscoreYAxisOffset?: number; @@ -589,7 +623,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ scheduleMarkerXAxisOffset?: number; @@ -608,7 +643,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ scheduleMarkerYAxisOffset?: number; @@ -627,7 +663,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ colSpace?: number; @@ -646,7 +683,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dailyFiveRowSpace?: number; @@ -665,7 +703,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ dailySixRowSpace?: number; @@ -684,7 +723,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ lunarHeight?: number; @@ -703,7 +743,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ underscoreWidth?: number; @@ -722,7 +763,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ underscoreLength?: number; @@ -741,7 +783,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ scheduleMarkerRadius?: number; @@ -760,7 +803,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ boundaryRowOffset?: number; @@ -779,7 +823,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ boundaryColOffset?: number; } @@ -799,7 +844,8 @@ interface CurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface NonCurrentDayStyle { /** @@ -817,7 +863,8 @@ interface NonCurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ nonCurrentMonthDayColor?: ResourceColor; @@ -836,7 +883,8 @@ interface NonCurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ nonCurrentMonthLunarColor?: ResourceColor; @@ -855,7 +903,8 @@ interface NonCurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ nonCurrentMonthWorkDayMarkColor?: ResourceColor; @@ -874,7 +923,8 @@ interface NonCurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ nonCurrentMonthOffDayMarkColor?: ResourceColor; } @@ -894,7 +944,8 @@ interface NonCurrentDayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface TodayStyle { /** @@ -912,7 +963,8 @@ interface TodayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ focusedDayColor?: ResourceColor; @@ -931,7 +983,8 @@ interface TodayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ focusedLunarColor?: ResourceColor; @@ -950,7 +1003,8 @@ interface TodayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ focusedAreaBackgroundColor?: ResourceColor; @@ -969,7 +1023,8 @@ interface TodayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ focusedAreaRadius?: number; } @@ -989,7 +1044,8 @@ interface TodayStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface WeekStyle { /** @@ -1007,7 +1063,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekColor?: ResourceColor; @@ -1026,7 +1083,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekendDayColor?: ResourceColor; @@ -1045,7 +1103,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekendLunarColor?: ResourceColor; @@ -1064,7 +1123,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekFontSize?: number; @@ -1083,7 +1143,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekHeight?: number; @@ -1102,7 +1163,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekWidth?: number; @@ -1121,7 +1183,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekAndDayRowSpace?: number; } @@ -1141,7 +1204,8 @@ interface WeekStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface WorkStateStyle { /** @@ -1159,7 +1223,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ workDayMarkColor?: ResourceColor; @@ -1178,7 +1243,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ offDayMarkColor?: ResourceColor; @@ -1197,7 +1263,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ workDayMarkSize?: number; @@ -1216,7 +1283,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ offDayMarkSize?: number; @@ -1235,7 +1303,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ workStateWidth?: number; @@ -1254,7 +1323,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ workStateHorizontalMovingDistance?: number; @@ -1273,7 +1343,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ workStateVerticalMovingDistance?: number; } @@ -1293,7 +1364,8 @@ interface WorkStateStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CalendarSelectedDate { /** @@ -1311,7 +1383,8 @@ declare interface CalendarSelectedDate { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ year: number; @@ -1330,7 +1403,8 @@ declare interface CalendarSelectedDate { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ month: number; @@ -1349,7 +1423,8 @@ declare interface CalendarSelectedDate { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ day: number; } @@ -1369,7 +1444,8 @@ declare interface CalendarSelectedDate { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CalendarRequestedData { /** @@ -1387,7 +1463,8 @@ declare interface CalendarRequestedData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ year: number; @@ -1406,7 +1483,8 @@ declare interface CalendarRequestedData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ month: number; @@ -1425,7 +1503,8 @@ declare interface CalendarRequestedData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ currentYear: number; @@ -1444,7 +1523,8 @@ declare interface CalendarRequestedData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ currentMonth: number; @@ -1463,11 +1543,59 @@ declare interface CalendarRequestedData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ monthState: number; } +/** + * Defines the struct of DateOptions. + * + * @interface DateOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ +interface DateOptions { + /** + * Gregorian calendar year. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + year: number; + + /** + * Gregorian calendar month. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + month: number; + + /** + * Gregorian calendar day. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + day: number +} /** * Calendar controller. * @@ -1481,7 +1609,8 @@ declare interface CalendarRequestedData { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CalendarController { /** @@ -1497,7 +1626,8 @@ declare class CalendarController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1518,6 +1648,17 @@ declare class CalendarController { */ backToToday(); + /** + * Back to day. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + backToToday():void; + /** * To the specified element. * @@ -1536,6 +1677,88 @@ declare class CalendarController { * @since 10 */ goTo(value: { year: number; month: number; day: number }); + /** + * To the specified element. + * + * @param { CalendarSelectedDate } date + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + goTo(date: CalendarSelectedDate): void; +} + +/** + * Defines the struct of CalendarRequestedMonths. + * + * @interface CalendarRequestedMonths + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ +declare interface CalendarRequestedMonths { + /** + * Default selected year/month/day. + * @type { CalendarSelectedDate } date + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + date: CalendarSelectedDate; + + /** + * Dates contained in the current month. + * + * @type { MonthData } currentData + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + currentData: MonthData; + + /** + * Dates contained in the previous month. + * + * @type { MonthData } preData + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + preData: MonthData; + + /** + * Dates contained in the next month. + * + * @type { MonthData } nextData + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + nextData: MonthData; + + /** + * Calendar controller. + * + * @type { ?CalendarController } controller + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + controller?: CalendarController; } /** @@ -1553,7 +1776,8 @@ declare class CalendarController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface CalendarInterface { /** @@ -1582,6 +1806,19 @@ interface CalendarInterface { nextData: MonthData; controller?: CalendarController; }): CalendarAttribute; + + /** + * Set value. + * + * @param { CalendarRequestedMonths } value + * @returns { CalendarAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ + (value: CalendarRequestedMonths): CalendarAttribute; } /** @@ -1593,7 +1830,8 @@ interface CalendarInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CalendarAttribute { /** @@ -1613,7 +1851,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ showLunar(value: boolean): CalendarAttribute; @@ -1634,7 +1873,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ showHoliday(value: boolean): CalendarAttribute; @@ -1655,7 +1895,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ needSlide(value: boolean): CalendarAttribute; @@ -1676,7 +1917,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ startOfWeek(value: number): CalendarAttribute; @@ -1697,7 +1939,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ offDays(value: number): CalendarAttribute; @@ -1718,7 +1961,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ direction(value: Axis): CalendarAttribute; @@ -1739,7 +1983,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ currentDayStyle(value: CurrentDayStyle): CalendarAttribute; @@ -1760,7 +2005,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ nonCurrentDayStyle(value: NonCurrentDayStyle): CalendarAttribute; @@ -1781,7 +2027,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ todayStyle(value: TodayStyle): CalendarAttribute; @@ -1802,7 +2049,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ weekStyle(value: WeekStyle): CalendarAttribute; @@ -1823,7 +2071,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ workStateStyle(value: WorkStateStyle): CalendarAttribute; @@ -1844,7 +2093,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ onSelectChange(event: (event: CalendarSelectedDate) => void): CalendarAttribute; @@ -1865,7 +2115,8 @@ declare class CalendarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ onRequestData( event: (event: CalendarRequestedData) => void, diff --git a/api/@internal/component/ets/calendar_picker.d.ts b/api/@internal/component/ets/calendar_picker.d.ts index fce47754f636ae7d8814abd7fa5a8b3a16423c20..64f5844db6d5be69fe59a28a94c8c6580df0cf6e 100644 --- a/api/@internal/component/ets/calendar_picker.d.ts +++ b/api/@internal/component/ets/calendar_picker.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource' +import { CommonMethod, PickerTextStyle, Callback, BlurStyle, PickerDialogButtonStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, DateRange, + BackgroundBlurStyleOptions, BackgroundEffectOptions, Optional } from './common' +import { Offset, VoidCallback, ResourceColor } from './units' +/*** endif */ + /** * The type of alignment between entry and calendar. * @enum {number} @@ -31,7 +38,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CalendarAlign { /** @@ -45,7 +53,8 @@ declare enum CalendarAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START = 0, /** @@ -59,7 +68,8 @@ declare enum CalendarAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 1, /** @@ -73,7 +83,8 @@ declare enum CalendarAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END = 2 } @@ -91,7 +102,8 @@ declare enum CalendarAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CalendarOptions { /** @@ -107,7 +119,8 @@ declare interface CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hintRadius?: number | Resource; @@ -124,7 +137,8 @@ declare interface CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selected?: Date; @@ -135,7 +149,8 @@ declare interface CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ start?: Date; @@ -146,7 +161,8 @@ declare interface CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ end?: Date; @@ -157,7 +173,8 @@ declare interface CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ disabledDateRange?: DateRange[]; } @@ -175,7 +192,8 @@ declare interface CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CalendarPickerInterface { /** @@ -193,7 +211,8 @@ interface CalendarPickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: CalendarOptions): CalendarPickerAttribute; } @@ -211,7 +230,8 @@ interface CalendarPickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CalendarPickerAttribute extends CommonMethod { /** @@ -231,10 +251,11 @@ declare class CalendarPickerAttribute extends CommonMethod } alignType - The type of alignment between entry and calendar dialog. @@ -243,7 +264,8 @@ declare class CalendarPickerAttribute extends CommonMethod, offset?: Offset): CalendarPickerAttribute; @@ -262,7 +284,8 @@ declare class CalendarPickerAttribute extends CommonMethod): CalendarPickerAttribute; @@ -296,23 +320,26 @@ declare class CalendarPickerAttribute extends CommonMethod } callback - callback for selected date changed. * @returns { CalendarPickerAttribute } the attribute of the CalendarPicker. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Callback): CalendarPickerAttribute; - /** + /** * Callback for selected date changed. * @param { Optional> } callback - callback for selected date changed. * @returns { CalendarPickerAttribute } the attribute of the CalendarPicker. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Optional>): CalendarPickerAttribute; @@ -324,7 +351,8 @@ declare class CalendarPickerAttribute extends CommonMethod } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAccept?: Callback; @@ -389,11 +420,13 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Called when the Cancel button in the dialog is clicked. + * Anonymous Object Rectification. * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onCancel?: VoidCallback; @@ -414,11 +447,13 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * This event is triggered when a date is selected in dialog. + * Anonymous Object Rectification. * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange?: Callback; @@ -439,7 +474,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -460,7 +496,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -471,7 +508,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -482,7 +520,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -493,7 +532,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ acceptButtonStyle?: PickerDialogButtonStyle; @@ -504,7 +544,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cancelButtonStyle?: PickerDialogButtonStyle; @@ -519,12 +560,14 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function when the dialog appears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: VoidCallback; @@ -539,12 +582,14 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function when the dialog disappears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: VoidCallback; @@ -559,12 +604,14 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function before the dialog openAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: VoidCallback; @@ -579,12 +626,14 @@ declare interface CalendarDialogOptions extends CalendarOptions { */ /** * Callback function before the dialog closeAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: VoidCallback; @@ -595,7 +644,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -607,7 +657,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -619,7 +670,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -631,7 +683,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ markToday?: boolean; } @@ -647,7 +700,8 @@ declare interface CalendarDialogOptions extends CalendarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CalendarPickerDialog { /** @@ -663,7 +717,8 @@ declare class CalendarPickerDialog { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static show(options?: CalendarDialogOptions): void; } diff --git a/api/@internal/component/ets/canvas.d.ts b/api/@internal/component/ets/canvas.d.ts index 65124aa016c37ca2bdc341176c610922b47f5d6f..053cbe26cfed33e35c4d896c9faffdbb80f0bf7f 100644 --- a/api/@internal/component/ets/canvas.d.ts +++ b/api/@internal/component/ets/canvas.d.ts @@ -18,6 +18,15 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, Callback, PixelMap } from './common'; +import { FrameNode } from '../FrameNode'; +import { ImageAIOptions, ImageAnalyzerConfig } from './imageCommon'; +import { Matrix2D } from './matrix2d'; +import { VoidCallback, LengthMetricsUnit, LengthMetrics } from './units'; +import { Size } from '../Graphics' +/*** endif */ + /** * Import the drawing canvas type object for Canvas. * @@ -73,7 +82,8 @@ declare type DrawingCanvas = import('../api/@ohos.graphics.drawing').default.Can * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type CanvasFillRule = "evenodd" | "nonzero"; @@ -125,7 +135,8 @@ declare type CanvasFillRule = "evenodd" | "nonzero"; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type CanvasLineCap = "butt" | "round" | "square"; @@ -189,7 +200,8 @@ declare type CanvasLineCap = "butt" | "round" | "square"; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type CanvasLineJoin = "bevel" | "miter" | "round"; @@ -237,7 +249,8 @@ declare type CanvasLineJoin = "bevel" | "miter" | "round"; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type CanvasDirection = "inherit" | "ltr" | "rtl"; @@ -301,7 +314,8 @@ declare type CanvasDirection = "inherit" | "ltr" | "rtl"; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start"; @@ -369,7 +383,8 @@ declare type CanvasTextAlign = "center" | "end" | "left" | "right" | "start"; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideographic" | "middle" | "top"; @@ -417,7 +432,8 @@ declare type CanvasTextBaseline = "alphabetic" | "bottom" | "hanging" | "ideogra * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ImageSmoothingQuality = "high" | "low" | "medium"; @@ -460,7 +476,8 @@ declare type FrameNode = import('../api/arkui/FrameNode').FrameNode; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CanvasGradient { /** @@ -503,7 +520,8 @@ declare class CanvasGradient { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addColorStop(offset: number, color: string): void; } @@ -536,7 +554,8 @@ declare class CanvasGradient { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CanvasPath { /** @@ -595,7 +614,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, counterclockwise?: boolean): void; @@ -647,7 +667,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void; @@ -703,7 +724,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number): void; @@ -735,7 +757,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ closePath(): void; @@ -807,7 +830,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ellipse( x: number, @@ -856,7 +880,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lineTo(x: number, y: number): void; @@ -896,7 +921,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ moveTo(x: number, y: number): void; @@ -944,7 +970,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void; @@ -992,7 +1019,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rect(x: number, y: number, w: number, h: number): void; } @@ -1029,7 +1057,8 @@ declare class CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class Path2D extends CanvasPath { /** @@ -1068,7 +1097,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addPath(path: Path2D, transform?: Matrix2D): void; @@ -1100,7 +1130,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1112,7 +1143,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(unit: LengthMetricsUnit); @@ -1148,7 +1180,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(path: Path2D); @@ -1161,7 +1194,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(path: Path2D, unit: LengthMetricsUnit); @@ -1197,7 +1231,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(d: string); @@ -1210,7 +1245,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(description: string, unit: LengthMetricsUnit); } @@ -1247,7 +1283,8 @@ declare class Path2D extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CanvasPattern { /** @@ -1282,7 +1319,8 @@ declare interface CanvasPattern { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setTransform(transform?: Matrix2D): void; } @@ -1319,7 +1357,8 @@ declare interface CanvasPattern { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextMetrics { /** @@ -1362,7 +1401,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly actualBoundingBoxAscent: number; @@ -1406,7 +1446,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly actualBoundingBoxDescent: number; @@ -1450,7 +1491,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly actualBoundingBoxLeft: number; @@ -1494,7 +1536,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly actualBoundingBoxRight: number; @@ -1538,7 +1581,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly alphabeticBaseline: number; @@ -1582,7 +1626,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly emHeightAscent: number; @@ -1626,7 +1671,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly emHeightDescent: number; @@ -1670,7 +1716,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontBoundingBoxAscent: number; @@ -1714,7 +1761,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontBoundingBoxDescent: number; @@ -1758,7 +1806,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly hangingBaseline: number; @@ -1802,7 +1851,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly ideographicBaseline: number; @@ -1842,7 +1892,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly width: number; @@ -1882,7 +1933,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly height: number; } @@ -1915,7 +1967,8 @@ declare interface TextMetrics { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageBitmap { /** @@ -1958,6 +2011,19 @@ declare class ImageBitmap { */ readonly height: number; + /** + * Indicates the height of the CSS pixel unit of ImageData. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get height(): number; + /** * Indicates the width of the CSS pixel unit of ImageData. * @@ -1998,6 +2064,19 @@ declare class ImageBitmap { */ readonly width: number; + /** + * Indicates the width of the CSS pixel unit of ImageData. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get width(): number; + /** * Releases all graphics resources associated with an ImageBitmap. * @@ -2026,7 +2105,8 @@ declare class ImageBitmap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; @@ -2116,6 +2196,19 @@ declare class ImageBitmap { * @since 12 */ constructor(data: PixelMap, unit: LengthMetricsUnit); + + /** + * Create an ImageBitmap object based on the transferred image path or PixelMap object. + * + * @param { PixelMap | string } src - image path or PixelMap object + * @param { LengthMetricsUnit } [unit] - the unit mode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(src: PixelMap | string, unit?: LengthMetricsUnit); } /** @@ -2146,7 +2239,8 @@ declare class ImageBitmap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageData { /** @@ -2189,6 +2283,19 @@ declare class ImageData { */ readonly data: Uint8ClampedArray; + /** + * Array containing image pixel data + * + * @return { Uint8ClampedArray } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get data(): Uint8ClampedArray; + /** * Width of the image. * @@ -2229,6 +2336,19 @@ declare class ImageData { */ readonly height: number; + /** + * Height of the image. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get height(): number; + /** * Height of the image. * @@ -2269,6 +2389,19 @@ declare class ImageData { */ readonly width: number; + /** + * Width of the image. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get width(): number; + /** * Create an ImageData object based on the input parameters. * @@ -2324,7 +2457,8 @@ declare class ImageData { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(width: number, height: number, data?: Uint8ClampedArray, unit?: LengthMetricsUnit); } @@ -2357,7 +2491,8 @@ declare class ImageData { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RenderingContextSettings { /** @@ -2396,6 +2531,32 @@ declare class RenderingContextSettings { */ antialias?: boolean; + /** + * Get the status whether anti-aliasing is enabled for canvas. The default value is false. + * + * @return { boolean | undefined } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get antialias(): boolean | undefined; + + /** + * Set the status whether anti-aliasing is enabled for canvas. The default value is false. + * + * @param { boolean | undefined } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set antialias(antialias: boolean | undefined); + /** * Create an RenderingContextSettings object based on the antialias and alpha. * @@ -2428,7 +2589,8 @@ declare class RenderingContextSettings { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(antialias?: boolean); } @@ -2465,7 +2627,8 @@ declare class RenderingContextSettings { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CanvasRenderer extends CanvasPath { /** @@ -2480,6 +2643,30 @@ declare class CanvasRenderer extends CanvasPath { */ letterSpacing: LengthMetrics | string; + /** + * Get spacing for letter. + * + * @return { LengthMetrics | string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get letterSpacing(): LengthMetrics | string; + + /** + * Set spacing for letter. + * + * @param { LengthMetrics | string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set letterSpacing(letterSpacing: LengthMetrics | string); + /** * Transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). * If the value is out of range, the assignment is invalid. @@ -2524,6 +2711,34 @@ declare class CanvasRenderer extends CanvasPath { */ globalAlpha: number; + /** + * Get transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). + * If the value is out of range, the assignment is invalid. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get globalAlpha(): number; + + /** + * Set transparency. The value ranges from 0.0 (completely transparent) to 1.0 (completely opaque). + * If the value is out of range, the assignment is invalid. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set globalAlpha(globalAlpha: number); + /** * Type of composition operation applied when drawing a new shape. The following types are supported: * source-over: (Default) Draws a new drawing on top of an existing canvas context. @@ -2620,6 +2835,60 @@ declare class CanvasRenderer extends CanvasPath { */ globalCompositeOperation: string; + /** + * Get the type of composition operation applied when drawing a new shape. The following types are supported: + * source-over: (Default) Draws a new drawing on top of an existing canvas context. + * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. + * Everything else is transparent. + * source-out: Draws a new drawing where it does not overlap with the existing canvas content. + * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. + * destination-over: Draws a new graphic behind the existing canvas content. + * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. + * Everything else is transparent. + * destination-out: Existing content remains where the new drawing does not overlap. + * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, + * which is drawn behind the canvas content. + * lighter: The color of two overlapping shapes is determined by adding the color values. + * copy: Only new graphics are displayed. + * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. + * + * @return { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get globalCompositeOperation(): string; + + /** + * Set the type of composition operation applied when drawing a new shape. The following types are supported: + * source-over: (Default) Draws a new drawing on top of an existing canvas context. + * source-in: The new drawing is drawn only where the new drawing overlaps the target canvas. + * Everything else is transparent. + * source-out: Draws a new drawing where it does not overlap with the existing canvas content. + * source-atop: The new drawing is drawn only where it overlaps the content of the existing canvas. + * destination-over: Draws a new graphic behind the existing canvas content. + * destination-in: Existing canvas content remains where the new drawing overlaps the existing canvas content. + * Everything else is transparent. + * destination-out: Existing content remains where the new drawing does not overlap. + * destination-atop: The existing canvas retains only the part that overlaps with the new drawing, + * which is drawn behind the canvas content. + * lighter: The color of two overlapping shapes is determined by adding the color values. + * copy: Only new graphics are displayed. + * xor: In the image, those overlaps and other places outside of the normal drawing are transparent. + * + * @param { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set globalCompositeOperation(globalCompositeOperation: string); + /** * Draw an image on a canvas * @@ -2660,7 +2929,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ drawImage(image: ImageBitmap | PixelMap, dx: number, dy: number): void; @@ -2712,7 +2982,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ drawImage(image: ImageBitmap | PixelMap, dx: number, dy: number, dw: number, dh: number): void; @@ -2780,7 +3051,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ drawImage( image: ImageBitmap | PixelMap, @@ -2822,7 +3094,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ beginPath(): void; @@ -2858,7 +3131,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clip(fillRule?: CanvasFillRule): void; @@ -2898,7 +3172,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clip(path: Path2D, fillRule?: CanvasFillRule): void; @@ -2934,7 +3209,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fill(fillRule?: CanvasFillRule): void; @@ -2974,7 +3250,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fill(path: Path2D, fillRule?: CanvasFillRule): void; @@ -3046,6 +3323,19 @@ declare class CanvasRenderer extends CanvasPath { */ stroke(path: Path2D): void; + /** + * Draws the specified path according to the current stroke style + * + * @param { Path2D } [path] - Specified stroke path object + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + stroke(path?: Path2D): void; + /** * Attributes that describe the fill color and style. The options are as follows: * color: Color String @@ -3100,6 +3390,40 @@ declare class CanvasRenderer extends CanvasPath { */ fillStyle: string | number | CanvasGradient | CanvasPattern; + /** + * Get the attributes specifie the color, gradient, or pattern to use inside shapes. The options are as follows: + * + * @return { string | number | CanvasGradient | CanvasPattern } + * string: Color String. + * number: Indicates the color with number. + * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. + * CanvasPattern: Template object. For details, see {@link CanvasPattern}. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get fillStyle(): string | number | CanvasGradient | CanvasPattern; + + /** + * Set the attributes specifie the color, gradient, or pattern to use inside shapes. The options are as follows: + * + * @param { string | number | CanvasGradient | CanvasPattern } + * string: Color String. + * number: Indicates the color with number. + * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. + * CanvasPattern: Template object. For details, see {@link CanvasPattern}. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set fillStyle(fillStyle: string | number | CanvasGradient | CanvasPattern); + /** * Attributes of the stroke color and style. The options are as follows: * color: Color String @@ -3155,22 +3479,58 @@ declare class CanvasRenderer extends CanvasPath { strokeStyle: string | number | CanvasGradient | CanvasPattern; /** - * Creates a linear gradient object that is specified along the parameter coordinates + * Get the attributes specifie the color, gradient, or pattern to use for the strokes (outlines) around shapes. + * The options are as follows: * - * @param { number } x0 - The x-axis coordinate of the start point. - * @param { number } y0 - The y-axis coordinate of the start point. - * @param { number } x1 - x-axis coordinate of the end point. - * @param { number } y1 - y-axis coordinate of the end point. - * @returns { CanvasGradient } + * @return { string | number | CanvasGradient | CanvasPattern } + * string: Color String. + * number: Indicates the color with number. + * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. + * CanvasPattern: Template object. For details, see {@link CanvasPattern}. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 8 + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 */ + get strokeStyle(): string | number | CanvasGradient | CanvasPattern; + /** - * Creates a linear gradient object that is specified along the parameter coordinates + * Set the attributes specifie the color, gradient, or pattern to use for the strokes (outlines) around shapes. + * The options are as follows: * - * @param { number } x0 - The x-axis coordinate of the start point. - * @param { number } y0 - The y-axis coordinate of the start point. - * @param { number } x1 - x-axis coordinate of the end point. + * @param { string | number | CanvasGradient | CanvasPattern } + * string: Color String. + * number: Indicates the color with number. + * CanvasGradient: Color gradient object. For details, see {@link CanvasGradient}. + * CanvasPattern: Template object. For details, see {@link CanvasPattern}. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set strokeStyle(strokeStyle: string | number | CanvasGradient | CanvasPattern); + + /** + * Creates a linear gradient object that is specified along the parameter coordinates + * + * @param { number } x0 - The x-axis coordinate of the start point. + * @param { number } y0 - The y-axis coordinate of the start point. + * @param { number } x1 - x-axis coordinate of the end point. + * @param { number } y1 - y-axis coordinate of the end point. + * @returns { CanvasGradient } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 8 + */ + /** + * Creates a linear gradient object that is specified along the parameter coordinates + * + * @param { number } x0 - The x-axis coordinate of the start point. + * @param { number } y0 - The y-axis coordinate of the start point. + * @param { number } x1 - x-axis coordinate of the end point. * @param { number } y1 - y-axis coordinate of the end point. * @returns { CanvasGradient } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -3202,7 +3562,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createLinearGradient(x0: number, y0: number, x1: number, y1: number): CanvasGradient; @@ -3266,7 +3627,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createPattern(image: ImageBitmap, repetition: string | null): CanvasPattern | null; @@ -3326,7 +3688,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, r1: number): CanvasGradient; @@ -3353,7 +3716,8 @@ declare class CanvasRenderer extends CanvasPath { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createConicGradient( startAngle: number, @@ -3465,6 +3829,64 @@ declare class CanvasRenderer extends CanvasPath { */ filter: string; + /** + * Provides filter effects such as blur and grayscale. You can get the following filter effects: + * blur(): Adds a Gaussian blur effect to the drawing + * brightness(): Provides a linear multiplication for the drawing and adjusts the brightness level. + * contrast(): Adjusts the contrast of the image. When the value is 0%, the image is completely black. + * When the value is 100%, there is no change in the image. + * grayscale(): Converts the image to a gray image. When the value is 100%, the image is completely gray. + * When the value is 0%, there is no change in the image. + * hue-rotate(): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. + * invert(): Inverted image (representing the effect of a photographic negative). When the value is 100%, + * the image is completely inverted. When the value is 0%, there is no change in the image. + * opacity(): Transparency of the image. At 0%, the image is completely transparent. + * When the value is 100%, there is no change in the image. + * saturate(): Perform saturation processing on the image. At 0%, the image is completely un-saturated. + * When the value is 100%, there is no change in the image. + * sepia(): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. + * When the value is 0%, there is no change in the image. + * none: Turn off filter effects + * + * @return { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get filter(): string; + + /** + * Provides filter effects such as blur and grayscale. You can set the following filter effects: + * blur(): Adds a Gaussian blur effect to the drawing + * brightness(): Provides a linear multiplication for the drawing and adjusts the brightness level. + * contrast(): Adjusts the contrast of the image. When the value is 0%, the image is completely black. + * When the value is 100%, there is no change in the image. + * grayscale(): Converts the image to a gray image. When the value is 100%, the image is completely gray. + * When the value is 0%, there is no change in the image. + * hue-rotate(): Perform color rotation on an image. When the value is 0 degrees, there is no change in the image. + * invert(): Inverted image (representing the effect of a photographic negative). When the value is 100%, + * the image is completely inverted. When the value is 0%, there is no change in the image. + * opacity(): Transparency of the image. At 0%, the image is completely transparent. + * When the value is 100%, there is no change in the image. + * saturate(): Perform saturation processing on the image. At 0%, the image is completely un-saturated. + * When the value is 100%, there is no change in the image. + * sepia(): The image is sepia (nostalgic style). At 100%, the image turns completely sepia. + * When the value is 0%, there is no change in the image. + * none: Turn off filter effects + * + * @param { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set filter(filter: string); + /** * Creates a new, empty ImageData object of the specified size * @@ -3505,7 +3927,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createImageData(sw: number, sh: number): ImageData; @@ -3549,7 +3972,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createImageData(imagedata: ImageData): ImageData; @@ -3601,7 +4025,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getImageData(sx: number, sy: number, sw: number, sh: number): ImageData; @@ -3639,7 +4064,8 @@ declare class CanvasRenderer extends CanvasPath { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getPixelMap(sx: number, sy: number, sw: number, sh: number): PixelMap; @@ -3683,7 +4109,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ putImageData(imagedata: ImageData, dx: number | string, dy: number | string): void; @@ -3759,7 +4186,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ putImageData( imagedata: ImageData, @@ -3815,6 +4243,34 @@ declare class CanvasRenderer extends CanvasPath { */ imageSmoothingEnabled: boolean; + /** + * Get the status whether to smooth the image. The value true indicates that the image is smooth. + * The value false indicates that the image is not smooth. + * + * @return { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get imageSmoothingEnabled(): boolean; + + /** + * Set the status whether to smooth the image. The value true indicates that the image is smooth. + * The value false indicates that the image is not smooth. + * + * @param { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set imageSmoothingEnabled(imageSmoothingEnabled: boolean); + /** * Smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. * @@ -3855,6 +4311,32 @@ declare class CanvasRenderer extends CanvasPath { */ imageSmoothingQuality: ImageSmoothingQuality; + /** + * Get the smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. + * + * @return { ImageSmoothingQuality } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get imageSmoothingQuality(): ImageSmoothingQuality; + + /** + * Set the smoothness level of the current image. For details, see {@link ImageSmoothingQuality}. + * + * @param { ImageSmoothingQuality } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set imageSmoothingQuality(imageSmoothingQuality: ImageSmoothingQuality); + /** * Line segment endpoint attribute. For details, see {@link CanvasLineCap}. * @@ -3894,6 +4376,32 @@ declare class CanvasRenderer extends CanvasPath { * @since 11 */ lineCap: CanvasLineCap; + + /** + * Get the line segment endpoint attribute. For details, see {@link CanvasLineCap}. + * + * @return { CanvasLineCap } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get lineCap(): CanvasLineCap; + + /** + * Set the line segment endpoint attribute. For details, see {@link CanvasLineCap}. + * + * @param { CanvasLineCap } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set lineCap(lineCap: CanvasLineCap); /** * Dotted line offset attribute. @@ -3935,6 +4443,32 @@ declare class CanvasRenderer extends CanvasPath { */ lineDashOffset: number; + /** + * Get the dotted line offset attribute. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get lineDashOffset(): number; + + /** + * Set the dotted line offset attribute. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set lineDashOffset(lineDashOffset: number); + /** * Line segment connection point attribute. For details, see {@link CanvasLineJoin}. * @@ -3975,6 +4509,32 @@ declare class CanvasRenderer extends CanvasPath { */ lineJoin: CanvasLineJoin; + /** + * Get the line segment connection point attribute. For details, see {@link CanvasLineJoin}. + * + * @return { CanvasLineJoin } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get lineJoin(): CanvasLineJoin; + + /** + * Set the line segment connection point attribute. For details, see {@link CanvasLineJoin}. + * + * @param { CanvasLineJoin } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set lineJoin(lineJoin: CanvasLineJoin); + /** * Line thickness attribute. The value cannot be 0 or a negative number. * @@ -4015,6 +4575,32 @@ declare class CanvasRenderer extends CanvasPath { */ lineWidth: number; + /** + * Get the line thickness attribute. The value cannot be 0 or a negative number. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get lineWidth(): number; + + /** + * Set the line thickness attribute. The value cannot be 0 or a negative number. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set lineWidth(lineWidth: number); + /** * The value of this parameter cannot be 0 or a negative number. * @@ -4055,6 +4641,32 @@ declare class CanvasRenderer extends CanvasPath { */ miterLimit: number; + /** + * Get the value of this parameter cannot be 0 or a negative number. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get miterLimit(): number; + + /** + * Set the value of this parameter cannot be 0 or a negative number. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set miterLimit(miterLimit: number); + /** * Gets the current segment style. * @@ -4087,7 +4699,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getLineDash(): number[]; @@ -4127,7 +4740,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setLineDash(segments: number[]): void; @@ -4175,7 +4789,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clearRect(x: number, y: number, w: number, h: number): void; @@ -4223,7 +4838,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fillRect(x: number, y: number, w: number, h: number): void; @@ -4271,7 +4887,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeRect(x: number, y: number, w: number, h: number): void; @@ -4315,6 +4932,32 @@ declare class CanvasRenderer extends CanvasPath { */ shadowBlur: number; + /** + * Get the shadow blur radius. The value cannot be a negative number. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get shadowBlur(): number; + + /** + * Set the shadow blur radius. The value cannot be a negative number. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set shadowBlur(shadowBlur: number); + /** * Shadow color. * @@ -4355,6 +4998,32 @@ declare class CanvasRenderer extends CanvasPath { */ shadowColor: string; + /** + * Get the shadow color. + * + * @return { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get shadowColor(): string; + + /** + * Set the shadow color. + * + * @param { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set shadowColor(shadowColor: string); + /** * Horizontal offset distance of the shadow. * @@ -4395,6 +5064,32 @@ declare class CanvasRenderer extends CanvasPath { */ shadowOffsetX: number; + /** + * Get the horizontal offset distance of the shadow. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get shadowOffsetX(): number; + + /** + * Set the horizontal offset distance of the shadow. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set shadowOffsetX(shadowOffsetX: number); + /** * Vertical offset distance of the shadow. * @@ -4435,6 +5130,32 @@ declare class CanvasRenderer extends CanvasPath { */ shadowOffsetY: number; + /** + * Get the vertical offset distance of the shadow. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get shadowOffsetY(): number; + + /** + * Set the vertical offset distance of the shadow. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set shadowOffsetY(shadowOffsetY: number); + /** * Top of the stack pop-up state in the drawing state stack * @@ -4463,7 +5184,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ restore(): void; @@ -4495,7 +5217,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ save(): void; @@ -4543,7 +5266,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fillText(text: string, x: number, y: number, maxWidth?: number): void; @@ -4583,7 +5307,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ measureText(text: string): TextMetrics; @@ -4631,7 +5356,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeText(text: string, x: number, y: number, maxWidth?: number): void; @@ -4675,6 +5401,32 @@ declare class CanvasRenderer extends CanvasPath { */ direction: CanvasDirection; + /** + * Get the text drawing direction. For details, see {@link CanvasDirection}. + * + * @return { CanvasDirection } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get direction(): CanvasDirection; + + /** + * Set the text drawing direction. For details, see {@link CanvasDirection}. + * + * @param { CanvasDirection } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set direction(direction: CanvasDirection); + /** * Font style. * @@ -4715,6 +5467,32 @@ declare class CanvasRenderer extends CanvasPath { */ font: string; + /** + * Get the font style. + * + * @return { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get font(): string; + + /** + * Set the font style. + * + * @param { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set font(font: string); + /** * Text alignment mode. For details, see {@link CanvasTextAlign}. * @@ -4755,6 +5533,32 @@ declare class CanvasRenderer extends CanvasPath { */ textAlign: CanvasTextAlign; + /** + * Get the text alignment mode. For details, see {@link CanvasTextAlign}. + * + * @return { CanvasTextAlign } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get textAlign(): CanvasTextAlign; + + /** + * Set the text alignment mode. For details, see {@link CanvasTextAlign}. + * + * @param { CanvasTextAlign } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set textAlign(textAlign: CanvasTextAlign); + /** * Text baseline. For details, see {@link CanvasTextBaseline}. * @@ -4795,6 +5599,32 @@ declare class CanvasRenderer extends CanvasPath { */ textBaseline: CanvasTextBaseline; + /** + * Get the text baseline. For details, see {@link CanvasTextBaseline}. + * + * @return { CanvasTextBaseline } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get textBaseline(): CanvasTextBaseline; + + /** + * Set the text baseline. For details, see {@link CanvasTextBaseline}. + * + * @param { CanvasTextBaseline } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set textBaseline(textBaseline: CanvasTextBaseline); + /** * Obtains the currently applied transformation matrix. * @@ -4827,7 +5657,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getTransform(): Matrix2D; @@ -4859,7 +5690,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ resetTransform(): void; @@ -4899,7 +5731,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotate(angle: number): void; @@ -4939,7 +5772,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scale(x: number, y: number): void; @@ -4999,7 +5833,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setTransform(a: number, b: number, c: number, d: number, e: number, f: number): void; @@ -5039,7 +5874,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setTransform(transform?: Matrix2D): void; @@ -5099,7 +5935,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ transform(a: number, b: number, c: number, d: number, e: number, f: number): void; @@ -5139,7 +5976,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ translate(x: number, y: number): void; @@ -5165,7 +6003,8 @@ declare class CanvasRenderer extends CanvasPath { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setPixelMap(value?: PixelMap): void; @@ -5201,7 +6040,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ transferFromImageBitmap(bitmap: ImageBitmap): void; @@ -5211,7 +6051,8 @@ declare class CanvasRenderer extends CanvasPath { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ saveLayer(): void; @@ -5221,18 +6062,20 @@ declare class CanvasRenderer extends CanvasPath { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ restoreLayer(): void; /** - * Clear the backing buffer, drawing state stack, any defined paths, and styles. - * - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 12 - */ + * Clear the backing buffer, drawing state stack, any defined paths, and styles. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ reset(): void; } @@ -5268,7 +6111,8 @@ declare class CanvasRenderer extends CanvasPath { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CanvasRenderingContext2D extends CanvasRenderer { /** @@ -5311,6 +6155,20 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { */ readonly height: number; + /** + * The default value is 0, which is bound to the height of the specified canvas. The value is read-only. + * + * @return { number } + * @readonly + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get height(): number; + /** * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. * @@ -5351,6 +6209,20 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { */ readonly width: number; + /** + * The default value is 0, which is bound to the width of the specified canvas. The value is read-only. + * + * @return { number } + * @readonly + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get width(): number; + /** * Frame node of the canvas. The default value is null. * @@ -5363,6 +6235,18 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { */ readonly canvas: FrameNode; + /** + * Frame node of the canvas. The default value is null. + * + * @return { FrameNode } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get canvas(): FrameNode; + /** * Generate a character string in the data url format. * @@ -5411,6 +6295,22 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { */ toDataURL(type?: string, quality?: any): string; + /** + * Generate a character string in the data url format. + * + * @param { string } [type] - Image format. The default value is image/png. + * @param { number } [quality] - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. + * If the value is out of the range, the default value 0.92 is used. + * @returns { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + toDataURL(type?: string, quality?: number): string; + /** * Start image analyzer. * @@ -5420,7 +6320,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @throws { BusinessError } 110002 - Image analysis is currently being executed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ startImageAnalyzer(config: ImageAnalyzerConfig): Promise; @@ -5428,7 +6329,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * Stop image analyzer. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stopImageAnalyzer(): void; @@ -5477,7 +6379,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(settings?: RenderingContextSettings, unit?: LengthMetricsUnit); @@ -5493,7 +6396,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'onAttach', callback: Callback): void; @@ -5509,7 +6413,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'onAttach', callback?: Callback): void; @@ -5525,7 +6430,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'onDetach', callback: Callback): void; @@ -5541,7 +6447,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'onDetach', callback?: Callback): void; } @@ -5578,7 +6485,8 @@ declare class CanvasRenderingContext2D extends CanvasRenderer { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { /** @@ -5629,6 +6537,22 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { */ toDataURL(type?: string, quality?: any): string; + /** + * Generate a character string in the data url format. + * + * @param { string } [type] - Image format. The default value is image/png. + * @param { number } [quality] - If the image format is image/jpeg or image/webp, you can select the image quality from 0 to 1. + * If the value is out of the range, the default value 0.92 is used. + * @returns { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + toDataURL(type?: string, quality?: number): string; + /** * transfer the content to ImageBitmap * @@ -5661,7 +6585,8 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ transferToImageBitmap(): ImageBitmap; @@ -5720,7 +6645,8 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(width: number, height: number, settings?: RenderingContextSettings, unit?: LengthMetricsUnit); } @@ -5756,7 +6682,8 @@ declare class OffscreenCanvasRenderingContext2D extends CanvasRenderer { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class OffscreenCanvas { /** @@ -5795,6 +6722,32 @@ declare class OffscreenCanvas { */ height: number; + /** + * Get the height of the off-screen canvas. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get height(): number; + + /** + * Set the height of the off-screen canvas. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set height(height: number); + /** * Width of the off-screen canvas. * @@ -5831,6 +6784,32 @@ declare class OffscreenCanvas { */ width: number; + /** + * Get the width of the off-screen canvas. + * + * @return { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get width(): number; + + /** + * Set the width of the off-screen canvas. + * + * @param { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + set width(width: number); + /** * Exports rendered content as an ImageBitmap object * @@ -5863,7 +6842,8 @@ declare class OffscreenCanvas { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ transferToImageBitmap(): ImageBitmap; @@ -5888,7 +6868,8 @@ declare class OffscreenCanvas { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getContext(contextType: "2d", options?: RenderingContextSettings): OffscreenCanvasRenderingContext2D; @@ -5945,8 +6926,24 @@ declare class OffscreenCanvas { * @since 12 */ constructor(width: number, height: number, unit: LengthMetricsUnit); + + /** + * Constructor of the off-screen canvas, which is used to create an off-screen canvas object. + * + * @param { number } width - Width of the off-screen canvas. + * @param { number } height - Height of the off-screen canvas. + * @param { LengthMetricsUnit } [unit] - the unit mode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(width: number, height: number, unit?: LengthMetricsUnit); } +/*** if arkts 1.1 */ /** * Size info. * @@ -5954,7 +6951,8 @@ declare class OffscreenCanvas { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Size { /** @@ -5964,7 +6962,8 @@ declare interface Size { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -5975,10 +6974,12 @@ declare interface Size { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } +/*** endif */ /** * Defines DrawingRenderingContext. @@ -5986,7 +6987,8 @@ declare interface Size { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DrawingRenderingContext { @@ -5997,7 +6999,8 @@ declare class DrawingRenderingContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ get size(): Size; @@ -6018,7 +7021,8 @@ declare class DrawingRenderingContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ invalidate(): void; @@ -6029,7 +7033,8 @@ declare class DrawingRenderingContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(unit?: LengthMetricsUnit); } @@ -6066,7 +7071,8 @@ declare class DrawingRenderingContext { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CanvasInterface { /** @@ -6116,7 +7122,8 @@ interface CanvasInterface { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (context?: CanvasRenderingContext2D | DrawingRenderingContext): CanvasAttribute; @@ -6128,7 +7135,8 @@ interface CanvasInterface { * @returns { CanvasAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (context: CanvasRenderingContext2D | DrawingRenderingContext, imageAIOptions: ImageAIOptions): CanvasAttribute; } @@ -6165,7 +7173,8 @@ interface CanvasInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CanvasAttribute extends CommonMethod { /** @@ -6215,7 +7224,8 @@ declare class CanvasAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onReady(event: VoidCallback): CanvasAttribute; @@ -6226,7 +7236,8 @@ declare class CanvasAttribute extends CommonMethod { * @returns { CanvasAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAnalyzer(enable: boolean): CanvasAttribute; } diff --git a/api/@internal/component/ets/checkbox.d.ts b/api/@internal/component/ets/checkbox.d.ts index 8a2718bdf318093a455b61ae2f33bb963f569f02..d1d796b173989e0de5b384b14784f65a1190e9a9 100644 --- a/api/@internal/component/ets/checkbox.d.ts +++ b/api/@internal/component/ets/checkbox.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonConfiguration, Callback, CommonMethod, ContentModifier, Optional, Bindable } from './common'; +import { CustomBuilder } from './builder'; +import { ResourceColor, MarkStyle } from './units'; +import { CheckBoxShape } from './enums'; +/*** endif */ + /** * Defines the options of Checkbox. * @@ -50,7 +57,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CheckboxOptions { /** @@ -85,7 +93,8 @@ declare interface CheckboxOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ name?: string; @@ -121,7 +130,8 @@ declare interface CheckboxOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ group?: string; @@ -132,7 +142,8 @@ declare interface CheckboxOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ indicatorBuilder?: CustomBuilder; } @@ -145,7 +156,8 @@ declare interface CheckboxOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CheckBoxConfiguration extends CommonConfiguration { /** @@ -155,7 +167,8 @@ declare interface CheckBoxConfiguration extends CommonConfiguration; } @@ -214,7 +229,8 @@ declare interface CheckBoxConfiguration extends CommonConfiguration void; @@ -307,7 +325,8 @@ declare type OnCheckboxChangeCallback = (value: boolean) => void; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CheckboxAttribute extends CommonMethod { /** @@ -363,6 +382,20 @@ declare class CheckboxAttribute extends CommonMethod { */ select(isSelected: Optional): CheckboxAttribute; + /** + * setting whether checkbox is selected. + * + * @param { boolean | undefined | Bindable } isSelected + * @returns { CheckboxAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + select(isSelected: boolean | undefined | Bindable): CheckboxAttribute; + /** * setting the display color of checkbox. * @@ -399,7 +432,8 @@ declare class CheckboxAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(value: ResourceColor): CheckboxAttribute; @@ -412,7 +446,8 @@ declare class CheckboxAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(resColor: Optional): CheckboxAttribute; @@ -435,7 +470,8 @@ declare class CheckboxAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shape(value: CheckBoxShape): CheckboxAttribute; @@ -448,7 +484,8 @@ declare class CheckboxAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ shape(shape: Optional): CheckboxAttribute; @@ -469,7 +506,8 @@ declare class CheckboxAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ unselectedColor(value: ResourceColor): CheckboxAttribute; @@ -481,7 +519,8 @@ declare class CheckboxAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ unselectedColor(resColor: Optional): CheckboxAttribute; @@ -502,7 +541,8 @@ declare class CheckboxAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mark(value: MarkStyle): CheckboxAttribute; @@ -514,7 +554,8 @@ declare class CheckboxAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ mark(style: Optional): CheckboxAttribute; @@ -565,7 +606,8 @@ declare class CheckboxAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: OnCheckboxChangeCallback): CheckboxAttribute; @@ -578,7 +620,8 @@ declare class CheckboxAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Optional): CheckboxAttribute; @@ -590,7 +633,8 @@ declare class CheckboxAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): CheckboxAttribute; @@ -602,7 +646,8 @@ declare class CheckboxAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: Optional>): CheckboxAttribute; } diff --git a/api/@internal/component/ets/checkboxgroup.d.ts b/api/@internal/component/ets/checkboxgroup.d.ts index 73155224395b0ad57e5aff8ebed347ebb946fd12..8864f9d769999bfcffa745ef6a49dda4d2907ef9 100644 --- a/api/@internal/component/ets/checkboxgroup.d.ts +++ b/api/@internal/component/ets/checkboxgroup.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, Optional, Bindable } from './common'; +import { ResourceColor, MarkStyle } from './units'; +import { CheckBoxShape } from './enums'; +/*** endif */ + /** * CheckboxGroup SelectStatus * @@ -50,7 +56,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SelectStatus { /** @@ -81,7 +88,8 @@ declare enum SelectStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ All, /** @@ -112,7 +120,8 @@ declare enum SelectStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Part, /** @@ -143,7 +152,8 @@ declare enum SelectStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -180,7 +190,8 @@ declare enum SelectStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CheckboxGroupOptions { /** @@ -215,7 +226,8 @@ declare interface CheckboxGroupOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ group?: string; } @@ -252,7 +264,8 @@ declare interface CheckboxGroupOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CheckboxGroupResult { /** @@ -287,7 +300,8 @@ declare interface CheckboxGroupResult { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ name: Array; /** @@ -322,7 +336,8 @@ declare interface CheckboxGroupResult { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ status: SelectStatus; } @@ -359,7 +374,8 @@ declare interface CheckboxGroupResult { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CheckboxGroupInterface { /** @@ -398,7 +414,8 @@ interface CheckboxGroupInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: CheckboxGroupOptions): CheckboxGroupAttribute; } @@ -412,7 +429,8 @@ interface CheckboxGroupInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnCheckboxGroupChangeCallback = (value: CheckboxGroupResult) => void; @@ -448,7 +466,8 @@ declare type OnCheckboxGroupChangeCallback = (value: CheckboxGroupResult) => voi * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CheckboxGroupAttribute extends CommonMethod { /** @@ -504,6 +523,20 @@ declare class CheckboxGroupAttribute extends CommonMethod): CheckboxGroupAttribute; + /** + * setting whether all checkbox is selected. + * + * @param { boolean| undefined|Bindable } isAllSelected + * @returns { CheckboxGroupAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + selectAll(isAllSelected: boolean | undefined | Bindable): CheckboxGroupAttribute; + /** * setting the display color of checkbox. * @@ -540,7 +573,8 @@ declare class CheckboxGroupAttribute extends CommonMethod): CheckboxGroupAttribute; @@ -574,7 +609,8 @@ declare class CheckboxGroupAttribute extends CommonMethod): CheckboxGroupAttribute; @@ -607,7 +644,8 @@ declare class CheckboxGroupAttribute extends CommonMethod): CheckboxGroupAttribute; @@ -670,7 +709,8 @@ declare class CheckboxGroupAttribute extends CommonMethod): CheckboxGroupAttribute; @@ -696,7 +737,8 @@ declare class CheckboxGroupAttribute extends CommonMethod): CheckboxGroupAttribute; } diff --git a/api/@internal/component/ets/circle.d.ts b/api/@internal/component/ets/circle.d.ts index 6c7a34bde2ead163cb0e8eeadd349f75e10d76de..5805726cf100810cf04df4f3f6cf7ee4048932f7 100644 --- a/api/@internal/component/ets/circle.d.ts +++ b/api/@internal/component/ets/circle.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonShapeMethod,CommonMethod } from './common'; +/*** endif */ + /** * Defines circle options for Circle component. * @@ -50,7 +54,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CircleOptions { /** @@ -85,7 +90,8 @@ declare interface CircleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: string | number; @@ -121,7 +127,8 @@ declare interface CircleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: string | number; } @@ -274,7 +281,8 @@ interface CircleInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CircleAttribute extends CommonShapeMethod {} @@ -341,3 +349,30 @@ declare const Circle: CircleInterface; * @since 11 */ declare const CircleInstance: CircleAttribute; + +/** + * Defines circle component. + * + * @interface CircleInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface CircleInterface { + /** + * Set the options for circle component. + * + * @param { CircleOptions } [value] - options to create circle component. + * @returns { CircleAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (value?: CircleOptions): CircleAttribute; +} diff --git a/api/@internal/component/ets/column.d.ts b/api/@internal/component/ets/column.d.ts index e943a2136a32a8529db8d46e1ac1f25535f5912e..02be253b698f4b5b1f38a0e0cc4d449e3ff65a1f 100644 --- a/api/@internal/component/ets/column.d.ts +++ b/api/@internal/component/ets/column.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { PointLightStyle, Optional, CommonMethod } from './common'; +import { HorizontalAlign, FlexAlign } from './enums'; +import { Resource } from './../../global/resource'; +/*** endif */ + /** * Defines the space property with string, number and resource unit. * @@ -26,7 +32,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type SpaceType = string | number | Resource; @@ -38,7 +45,8 @@ declare type SpaceType = string | number | Resource; * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ interface ColumnOptions { /** @@ -73,7 +81,8 @@ interface ColumnOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ space?: string | number; } @@ -86,7 +95,8 @@ interface ColumnOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface ColumnOptionsV2 { /** @@ -97,7 +107,8 @@ interface ColumnOptionsV2 { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ space?: SpaceType; } @@ -134,7 +145,8 @@ interface ColumnOptionsV2 { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ColumnInterface { /** @@ -192,7 +204,8 @@ interface ColumnInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: ColumnOptions): ColumnAttribute; /** @@ -204,7 +217,8 @@ interface ColumnInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: ColumnOptions | ColumnOptionsV2): ColumnAttribute; } @@ -241,7 +255,8 @@ interface ColumnInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ColumnAttribute extends CommonMethod { /** @@ -280,7 +295,8 @@ declare class ColumnAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignItems(value: HorizontalAlign): ColumnAttribute; @@ -320,7 +336,8 @@ declare class ColumnAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ justifyContent(value: FlexAlign): ColumnAttribute; /** @@ -330,7 +347,8 @@ declare class ColumnAttribute extends CommonMethod { * @returns { ColumnAttribute } The attribute of the column. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pointLight(value: PointLightStyle): ColumnAttribute; /** @@ -342,7 +360,8 @@ declare class ColumnAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reverse(isReversed: Optional): ColumnAttribute; } diff --git a/api/@internal/component/ets/column_split.d.ts b/api/@internal/component/ets/column_split.d.ts index f76e6cc09da387856ea2096a1079ca28614b94c2..4ad3617ad8ed6b196c97a1b150fcbea635c855ec 100644 --- a/api/@internal/component/ets/column_split.d.ts +++ b/api/@internal/component/ets/column_split.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Dimension } from './units'; +import { CommonMethod } from './common'; +/*** endif */ + /** * Defines the ColumnSplit component. * @@ -40,7 +45,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ColumnSplitInterface { /** @@ -65,7 +71,8 @@ interface ColumnSplitInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): ColumnSplitAttribute; } @@ -85,7 +92,8 @@ interface ColumnSplitInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ColumnSplitDividerStyle { /** @@ -105,7 +113,8 @@ interface ColumnSplitDividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startMargin?: Dimension; @@ -126,7 +135,8 @@ interface ColumnSplitDividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endMargin?: Dimension; } @@ -153,7 +163,8 @@ interface ColumnSplitDividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ColumnSplitAttribute extends CommonMethod { /** @@ -181,7 +192,8 @@ declare class ColumnSplitAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ resizeable(value: boolean): ColumnSplitAttribute; @@ -202,7 +214,8 @@ declare class ColumnSplitAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ divider(value: ColumnSplitDividerStyle | null): ColumnSplitAttribute; } diff --git a/api/@internal/component/ets/common.d.ts b/api/@internal/component/ets/common.d.ts index c864a1812c96f3d479a626672a7fe117238c8300..23bd0a037819c455bfe56ad0b5290471e6aecdfb 100644 --- a/api/@internal/component/ets/common.d.ts +++ b/api/@internal/component/ets/common.d.ts @@ -18,6 +18,57 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import OriginalContext from '../../application/Context'; +import { Resource } from '../../global/resource'; +import pointer from '../../@ohos.multimodalInput.pointer'; +import image from '../../@ohos.multimedia.image'; +import unifiedDataChannel from '../../@ohos.data.unifiedDataChannel'; +import promptAction from '../../@ohos.promptAction'; +import uniformTypeDescriptor from '../../@ohos.data.uniformTypeDescriptor'; +import { IntentionCode } from '../../@ohos.multimodalInput.intentionCode'; +import { SymbolGlyphModifier } from '../../arkui/SymbolGlyphModifier'; +import { CircleShape, EllipseShape, PathShape, RectShape } from '../../@ohos.arkui.shape'; +import uiObserver from '../../@ohos.arkui.observer'; +import { UIContext } from '../../@ohos.arkui.UIContext'; +import { DrawContext, LengthMetrics } from '../../arkui/Graphics'; +import uiEffect from '../../@ohos.graphics.uiEffect'; +import { FocusBoxStyle, FocusPriority } from './focus'; +import { ComponentContent } from '../../arkui/ComponentContent'; +import { ResizableOptions } from './image'; +import { Theme } from '../../@ohos.arkui.theme'; +import intl from '../../@ohos.intl'; +import { ButtonType, ButtonStyleMode, ButtonRole } from './button'; +import { + Area, ResourceColor, Dimension, ResourceStr, Font, Length, EdgeColors, + LocalizedEdgeColors, BorderRadiuses, EdgeWidths, LocalizedEdgeWidths, SizeOptions, Bias, + EdgeStyles, Position, LocalizedBorderRadiuses, Margin, ChainWeightOptions, Padding, LocalizedPadding, LocalizedMargin, + BorderOptions, OutlineOptions, EdgeOutlineStyles, EdgeOutlineWidths, OutlineRadiuses, Edges, LocalizedEdges, LocalizedPosition, + AccessibilityOptions, ConstraintSizeOptions, EdgeWidth, DirectionalEdgesT, VoidCallback + } from './units'; +import { BaseGestureEvent, GestureRecognizer, GestureJudgeResult, GestureType, + GestureMask, GestureHandler, GesturePriority, GestureInfo + } from './gesture'; +import { ScrollState } from './list'; +import { + AccessibilityHoverType, Curve, PlayMode, SharedTransitionEffectType, KeySource, BorderStyle, + HorizontalAlign, VerticalAlign, MouseButton, MouseAction, TransitionType, FontWeight, TouchType, + FontStyle, Color, ColoringStrategy, Placement, ArrowPointPosition, ClickEffectLevel, NestedScrollMode, HitTestMode, + Alignment, ImageRepeat, ImageSize, HoverEffect, Visibility, ItemAlign, Direction, Axis, GradientDirection, FunctionKey, + ModifierKey, ObscuredReasons, RenderFit, LineCapStyle, LineJoinStyle, PixelRoundCalcPolicy, IlluminatedType, TextDecorationType, + TextDecorationStyle, KeyType, ResponseType, BarState, EdgeEffect, ScrollSource, InteractionHand, AxisAction, AxisModel, CrownAction, + FocusDrawLevel, CrownSensitivity +} from './enums'; +import { TextRange } from './textCommon'; +import { StyledString } from './styledString'; +import { CircleAttribute } from './circle'; +import { RectAttribute } from './rect'; +import { PathAttribute } from './path'; +import { EllipseAttribute } from './ellipse'; +import { LocalStorage } from '../stateManagement/storage/localStorage'; +import { CustomBuilder, WrappedBuilder } from './builder'; +/*** endif */ + /** * Defines the options of Component ClassDecorator. * @@ -77,11 +128,12 @@ declare interface ComponentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface InputCounterOptions { /** - * It is the numerator bit of the percentage and used as a threshold. If the number of characters input + * It is the numerator bit of the percentage and used as a threshold. If the number of characters input * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -89,16 +141,17 @@ declare interface InputCounterOptions { * @since 11 */ /** - * It is the numerator bit of the percentage and used as a threshold. If the number of characters input + * It is the numerator bit of the percentage and used as a threshold. If the number of characters input * reaches the maximum number of characters multiplied by this threshold, the counter is displayed. * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ thresholdPercentage?: number; - + /** * If the current input character count reaches the maximum character count and users want to exceed the * normal input, the border will turn red. If this parameter is true, the red border displayed. @@ -116,7 +169,8 @@ declare interface InputCounterOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ highlightBorder?: boolean; } @@ -128,7 +182,8 @@ declare interface InputCounterOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextDecorationOptions { /** @@ -138,7 +193,8 @@ declare interface TextDecorationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: TextDecorationType; @@ -149,7 +205,8 @@ declare interface TextDecorationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -160,7 +217,8 @@ declare interface TextDecorationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: TextDecorationStyle; } @@ -273,11 +331,71 @@ declare interface EntryOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ useSharedStorage? : boolean, } +/** + * Provides an interface for the style of an divider including stroke width, color, start margin + * and end margin + * + * @interface DividerStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface DividerStyle { + /** + * Define the stroke width of the divider + * + * @type { Length } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + strokeWidth: Length; + + /** + * Define the color of the divider + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color?: ResourceColor; + + /** + * Define the start margin of the divider + * + * @type { ?Length } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + startMargin?: Length; + + /** + * Define the end margin of the divider + * + * @type { ?Length } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + endMargin?: Length; +} + /** * Defines Entry ClassDecorator. * @@ -1067,7 +1185,8 @@ declare interface IMonitorValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AnimatableArithmetic { /** @@ -1087,7 +1206,8 @@ declare interface IMonitorValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ plus(rhs: AnimatableArithmetic): AnimatableArithmetic; @@ -1108,7 +1228,8 @@ declare interface IMonitorValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ subtract(rhs: AnimatableArithmetic): AnimatableArithmetic; @@ -1129,7 +1250,8 @@ declare interface IMonitorValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ multiply(scale: number): AnimatableArithmetic; @@ -1150,7 +1272,8 @@ declare interface IMonitorValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ equals(rhs: AnimatableArithmetic): boolean; } @@ -1185,7 +1308,7 @@ declare const Concurrent: MethodDecorator; * A function with this decorator is marked as sendable, and the function can be an shareable property of sendable-class object. * A typeAlias with this decorator is marked as sendable, and the typeAlias can be used to declare properties, variables, * and arguments that need to be assigned with sendable-function. - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -1334,7 +1457,8 @@ declare const ReusableV2: ClassDecorator; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ReuseIdCallback = () => string; @@ -1345,7 +1469,8 @@ declare const ReusableV2: ClassDecorator; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ReuseOptions { /** @@ -1355,7 +1480,8 @@ declare interface ReuseOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ reuseId? : ReuseIdCallback; } @@ -1388,6 +1514,19 @@ declare interface ReuseOptions { */ declare type Context = import('../api/application/Context').default; +/** + * Export Context. + * + * @typedef { OriginalContext } Context + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export type Context = OriginalContext; + /** * Post Card Action. * @@ -1419,7 +1558,8 @@ declare type Context = import('../api/application/Context').default; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare function postCardAction(component: Object, action: Object): void; @@ -1455,7 +1595,8 @@ declare function postCardAction(component: Object, action: Object): void; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Configuration { /** @@ -1494,7 +1635,8 @@ declare interface Configuration { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly colorMode: string; @@ -1534,7 +1676,8 @@ declare interface Configuration { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontScale: number; } @@ -1571,7 +1714,8 @@ declare interface Configuration { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Rectangle { /** @@ -1606,7 +1750,8 @@ declare interface Rectangle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: Length; @@ -1642,7 +1787,8 @@ declare interface Rectangle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: Length; @@ -1678,7 +1824,8 @@ declare interface Rectangle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Length; @@ -1714,7 +1861,8 @@ declare interface Rectangle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: Length; } @@ -1741,7 +1889,8 @@ declare interface Rectangle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ExpectedFrameRateRange { /** @@ -1766,7 +1915,8 @@ declare interface ExpectedFrameRateRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ min: number, /** @@ -1791,7 +1941,8 @@ declare interface ExpectedFrameRateRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ max: number, /** @@ -1822,7 +1973,8 @@ declare interface ExpectedFrameRateRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ expected: number, } @@ -1871,6 +2023,21 @@ declare interface ExpectedFrameRateRange { */ declare function $r(value: string, ...params: any[]): Resource; +/** + * global $r function + * + * @param { string } value + * @param { (Object | null | undefined)[] } params + * @returns { Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare function $r(value: string, ...params: (Object | null | undefined)[]): Resource; + /** * global $rawfile function * @@ -1907,7 +2074,8 @@ declare function $r(value: string, ...params: any[]): Resource; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare function $rawfile(value: string): Resource; /** @@ -1917,7 +2085,8 @@ declare function $rawfile(value: string): Resource; * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AccessibilitySamePageMode { /** @@ -1926,7 +2095,8 @@ declare enum AccessibilitySamePageMode { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SEMI_SILENT = 0, /** @@ -1935,7 +2105,8 @@ declare enum AccessibilitySamePageMode { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FULL_SILENT = 1, } @@ -1946,7 +2117,8 @@ declare enum AccessibilitySamePageMode { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AccessibilityRoleType { /** @@ -1955,7 +2127,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_SHEET = 0, /** @@ -1964,7 +2137,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ALERT_DIALOG = 1, /** @@ -1973,7 +2147,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ INDEXER_COMPONENT = 2, /** @@ -1982,7 +2157,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BADGE_COMPONENT = 3, /** @@ -1991,7 +2167,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BLANK = 4, /** @@ -2000,7 +2177,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BUTTON = 5, /** @@ -2009,7 +2187,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BACK_BUTTON = 6, /** @@ -2018,7 +2197,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SHEET_DRAG_BAR = 7, /** @@ -2027,7 +2207,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CALENDAR_PICKER = 8, /** @@ -2036,7 +2217,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CALENDAR = 9, /** @@ -2045,7 +2227,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CANVAS = 10, /** @@ -2054,7 +2237,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CANVAS_GRADIENT = 11, /** @@ -2063,7 +2247,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CANVAS_PATTERN = 12, /** @@ -2072,7 +2257,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CHECKBOX = 13, /** @@ -2081,7 +2267,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CHECKBOX_GROUP = 14, /** @@ -2090,7 +2277,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CIRCLE = 15, /** @@ -2099,7 +2287,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ COLUMN_SPLIT = 16, /** @@ -2108,7 +2297,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ COLUMN = 17, /** @@ -2117,7 +2307,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CANVAS_RENDERING_CONTEXT_2D = 18, /** @@ -2126,7 +2317,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CHART = 19, /** @@ -2135,7 +2327,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ COUNTER = 20, /** @@ -2144,7 +2337,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CONTAINER_MODAL = 21, /** @@ -2153,7 +2347,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DATA_PANEL = 22, /** @@ -2162,7 +2357,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_PICKER = 23, /** @@ -2171,7 +2367,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DIALOG = 24, /** @@ -2180,7 +2377,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DIVIDER = 25, /** @@ -2189,7 +2387,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DRAG_BAR = 26, /** @@ -2198,7 +2397,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ EFFECT_COMPONENT = 27, /** @@ -2207,7 +2407,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ELLIPSE = 28, /** @@ -2216,7 +2417,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FLEX = 29, /** @@ -2225,7 +2427,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FLOW_ITEM = 30, /** @@ -2234,7 +2437,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FORM_COMPONENT = 31, /** @@ -2243,7 +2447,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FORM_LINK = 32, /** @@ -2252,7 +2457,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ GAUGE = 33, /** @@ -2261,7 +2467,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ GRID = 34, /** @@ -2270,7 +2477,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ GRID_COL = 35, /** @@ -2279,7 +2487,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ GRID_CONTAINER = 36, /** @@ -2288,7 +2497,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ GRID_ITEM = 37, /** @@ -2297,7 +2507,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ GRID_ROW = 38, /** @@ -2306,7 +2517,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ HYPERLINK = 39, /** @@ -2315,7 +2527,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 40, /** @@ -2324,7 +2537,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_ANIMATOR = 41, /** @@ -2333,7 +2547,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_BITMAP = 42, /** @@ -2342,7 +2557,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_DATA = 43, /** @@ -2351,7 +2567,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_SPAN = 44, /** @@ -2360,7 +2577,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LABEL = 45, /** @@ -2369,7 +2587,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LINE = 46, /** @@ -2378,7 +2597,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LIST = 47, /** @@ -2387,7 +2607,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LIST_ITEM = 48, /** @@ -2396,7 +2617,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LIST_ITEM_GROUP = 49, /** @@ -2405,7 +2627,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LOADING_PROGRESS = 50, /** @@ -2414,7 +2637,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MARQUEE = 51, /** @@ -2423,7 +2647,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MATRIX2D = 52, /** @@ -2432,7 +2657,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MENU = 53, /** @@ -2441,7 +2667,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MENU_ITEM = 54, /** @@ -2450,7 +2677,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MENU_ITEM_GROUP = 55, /** @@ -2459,7 +2687,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NAV_DESTINATION = 56, /** @@ -2468,7 +2697,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NAV_ROUTER = 57, /** @@ -2477,7 +2707,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION = 58, /** @@ -2486,7 +2717,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION_BAR = 59, /** @@ -2495,7 +2727,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION_MENU = 60, /** @@ -2504,7 +2737,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATOR = 61, /** @@ -2513,7 +2747,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ OFFSCREEN_CANVAS = 62, /** @@ -2522,7 +2757,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ OFFSCREEN_CANVAS_RENDERING_CONTEXT2D = 63, /** @@ -2531,7 +2767,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ OPTION = 64, /** @@ -2540,7 +2777,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PANEL = 65, /** @@ -2549,7 +2787,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PAPER_PAGE = 66, /** @@ -2558,7 +2797,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PATH = 67, /** @@ -2567,7 +2807,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PATH2D = 68, /** @@ -2576,7 +2817,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PATTERN_LOCK = 69, /** @@ -2585,7 +2827,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PICKER = 70, /** @@ -2594,7 +2837,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PICKER_VIEW = 71, /** @@ -2603,7 +2847,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PLUGIN_COMPONENT = 72, /** @@ -2612,7 +2857,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ POLYGON = 73, /** @@ -2621,7 +2867,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ POLYLINE = 74, /** @@ -2630,7 +2877,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ POPUP = 75, /** @@ -2639,7 +2887,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PROGRESS = 76, /** @@ -2648,7 +2897,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ QRCODE = 77, /** @@ -2657,7 +2907,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RADIO = 78, /** @@ -2666,7 +2917,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RATING = 79, /** @@ -2675,7 +2927,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RECT = 80, /** @@ -2684,7 +2937,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ REFRESH = 81, /** @@ -2693,7 +2947,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RELATIVE_CONTAINER = 82, /** @@ -2702,7 +2957,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ REMOTE_WINDOW = 83, /** @@ -2711,7 +2967,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RICH_EDITOR = 84, /** @@ -2720,7 +2977,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RICH_TEXT = 85, /** @@ -2729,7 +2987,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ROLE_PAGER = 86, /** @@ -2738,7 +2997,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ROW = 87, /** @@ -2747,7 +3007,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ROW_SPLIT = 88, /** @@ -2756,7 +3017,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL = 89, /** @@ -2765,7 +3027,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_BAR = 90, /** @@ -2774,7 +3037,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SEARCH = 91, /** @@ -2783,7 +3047,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SEARCH_FIELD = 92, /** @@ -2792,7 +3057,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SELECT = 93, /** @@ -2801,7 +3067,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SHAPE = 94, /** @@ -2810,7 +3077,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SIDEBAR_CONTAINER = 95, /** @@ -2819,7 +3087,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SLIDER = 96, /** @@ -2828,7 +3097,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SPAN = 97, /** @@ -2837,7 +3107,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ STACK = 98, /** @@ -2846,7 +3117,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ STEPPER = 99, /** @@ -2855,7 +3127,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ STEPPER_ITEM = 100, /** @@ -2864,7 +3137,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SWIPER = 101, /** @@ -2873,7 +3147,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SWIPER_INDICATOR = 102, /** @@ -2882,7 +3157,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SWITCH = 103, /** @@ -2891,7 +3167,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SYMBOL_GLYPH = 104, /** @@ -2900,7 +3177,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TAB_CONTENT = 105, /** @@ -2909,7 +3187,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TAB_BAR = 106, /** @@ -2918,7 +3197,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TABS = 107, /** @@ -2927,7 +3207,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT = 108, /** @@ -2936,7 +3217,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_CLOCK = 109, /** @@ -2945,7 +3227,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_ENTRY = 110, /** @@ -2954,7 +3237,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_INPUT = 111, /** @@ -2963,7 +3247,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_PICKER = 112, /** @@ -2972,7 +3257,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_TIMER = 113, /** @@ -2981,7 +3267,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_AREA = 114, /** @@ -2990,7 +3277,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_FIELD = 115, /** @@ -2999,7 +3287,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TIME_PICKER = 116, /** @@ -3008,7 +3297,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TITLE_BAR = 117, /** @@ -3017,7 +3307,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TOGGLER = 118, /** @@ -3026,7 +3317,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ UI_EXTENSION_COMPONENT = 119, /** @@ -3035,7 +3327,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO = 120, /** @@ -3044,7 +3337,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ WATER_FLOW = 121, /** @@ -3053,7 +3347,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ WEB = 122, /** @@ -3062,7 +3357,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ XCOMPONENT = 123, /** @@ -3071,7 +3367,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ROLE_NONE = 124, } @@ -3084,7 +3381,8 @@ declare enum AccessibilityRoleType { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type AccessibilityFocusCallback = (isFocus: boolean) => void; @@ -3105,7 +3403,8 @@ declare type AccessibilityFocusCallback = (isFocus: boolean) => void; * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FinishCallbackType { /** @@ -3123,7 +3422,8 @@ declare enum FinishCallbackType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REMOVED = 0, /** @@ -3141,7 +3441,8 @@ declare enum FinishCallbackType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOGICALLY = 1, } @@ -3163,7 +3464,8 @@ declare enum FinishCallbackType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TouchTestStrategy { /** @@ -3181,7 +3483,8 @@ declare enum TouchTestStrategy { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -3200,7 +3503,8 @@ declare enum TouchTestStrategy { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FORWARD_COMPETITION = 1, @@ -3219,7 +3523,8 @@ declare enum TouchTestStrategy { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FORWARD = 2 } @@ -3256,7 +3561,8 @@ declare enum TouchTestStrategy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AnimateParam { /** @@ -3295,7 +3601,8 @@ declare interface AnimateParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; /** @@ -3326,7 +3633,8 @@ declare interface AnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ tempo?: number; /** @@ -3365,7 +3673,8 @@ declare interface AnimateParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | string | ICurve; @@ -3394,7 +3703,8 @@ declare interface AnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ delay?: number; @@ -3423,7 +3733,8 @@ declare interface AnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ iterations?: number; @@ -3463,7 +3774,8 @@ declare interface AnimateParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ playMode?: PlayMode; @@ -3499,7 +3811,8 @@ declare interface AnimateParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish?: () => void; @@ -3520,7 +3833,8 @@ declare interface AnimateParam { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ finishCallbackType?: FinishCallbackType; @@ -3537,7 +3851,8 @@ declare interface AnimateParam { * @type { ?ExpectedFrameRateRange } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ expectedFrameRateRange?: ExpectedFrameRateRange; } @@ -3567,7 +3882,8 @@ declare interface AnimateParam { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ICurve { /** @@ -3601,7 +3917,8 @@ interface ICurve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interpolate(fraction: number): number; } @@ -3628,7 +3945,8 @@ interface ICurve { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MotionPathOptions { /** @@ -3653,7 +3971,8 @@ declare interface MotionPathOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ path: string; @@ -3682,7 +4001,8 @@ declare interface MotionPathOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ from?: number; @@ -3711,7 +4031,8 @@ declare interface MotionPathOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ to?: number; @@ -3740,7 +4061,8 @@ declare interface MotionPathOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotatable?: boolean; } @@ -3767,7 +4089,8 @@ declare interface MotionPathOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface sharedTransitionOptions { /** @@ -3795,7 +4118,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; @@ -3824,7 +4148,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | string | ICurve; @@ -3853,7 +4178,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ delay?: number; @@ -3879,7 +4205,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ motionPath?: MotionPathOptions; @@ -3905,7 +4232,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ zIndex?: number; @@ -3934,7 +4262,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type?: SharedTransitionEffectType; } @@ -3954,7 +4283,8 @@ declare interface sharedTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GeometryTransitionOptions { /** @@ -3974,12 +4304,13 @@ declare interface GeometryTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ follow?: boolean; /** * Defines movement strategy of source and target in the hierarchy during geometry transition. - * + * * @type { ?TransitionHierarchyStrategy } * @default TransitionHierarchyStrategy.ADAPTIVE * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -3989,12 +4320,13 @@ declare interface GeometryTransitionOptions { */ /** * Defines movement strategy of source and target in the hierarchy during geometry transition. - * + * * @type { ?TransitionHierarchyStrategy } * @default TransitionHierarchyStrategy.ADAPTIVE * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ hierarchyStrategy?: TransitionHierarchyStrategy } @@ -4007,7 +4339,8 @@ declare interface GeometryTransitionOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LinearGradientOptions { /** @@ -4064,7 +4397,8 @@ declare interface LinearGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ angle?: number | string; @@ -4122,7 +4456,8 @@ declare interface LinearGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: GradientDirection; @@ -4179,7 +4514,8 @@ declare interface LinearGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ colors: Array<[ResourceColor, number]>; @@ -4237,7 +4573,8 @@ declare interface LinearGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ repeating?: boolean; } @@ -4250,7 +4587,8 @@ declare interface LinearGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SweepGradientOptions { /** @@ -4306,7 +4644,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ center: [Length, Length]; @@ -4365,7 +4704,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ start?: number | string; @@ -4422,7 +4762,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ end?: number | string; @@ -4480,7 +4821,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ rotation?: number | string; @@ -4537,7 +4879,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ colors: Array<[ResourceColor, number]>; @@ -4595,7 +4938,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ repeating?: boolean; } @@ -4608,7 +4952,8 @@ declare interface SweepGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RadialGradientOptions { /** @@ -4664,7 +5009,8 @@ declare interface RadialGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ center: [Length, Length]; @@ -4721,7 +5067,8 @@ declare interface RadialGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ radius: Length; @@ -4778,7 +5125,8 @@ declare interface RadialGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ colors: Array<[ResourceColor, number]>; @@ -4836,7 +5184,8 @@ declare interface RadialGradientOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ repeating?: boolean; } @@ -4862,7 +5211,8 @@ declare interface RadialGradientOptions { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TransitionHierarchyStrategy { /** @@ -4880,7 +5230,8 @@ declare enum TransitionHierarchyStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -4901,7 +5252,8 @@ declare enum TransitionHierarchyStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ ADAPTIVE = 1, } @@ -4938,7 +5290,8 @@ declare enum TransitionHierarchyStrategy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TranslateOptions { /** @@ -4973,7 +5326,8 @@ declare interface TranslateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number | string; @@ -5009,7 +5363,8 @@ declare interface TranslateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number | string; @@ -5045,7 +5400,8 @@ declare interface TranslateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ z?: number | string; } @@ -5082,7 +5438,8 @@ declare interface TranslateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScaleOptions { /** @@ -5117,7 +5474,8 @@ declare interface ScaleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; @@ -5153,7 +5511,8 @@ declare interface ScaleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; @@ -5189,7 +5548,8 @@ declare interface ScaleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ z?: number; @@ -5225,7 +5585,8 @@ declare interface ScaleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerX?: number | string; @@ -5261,11 +5622,155 @@ declare interface ScaleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerY?: number | string; } +/** + * Defines the align rule options of relative container. + * + * @interface AlignRuleParam + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface AlignRuleParam { + /** + * The param of anchor. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + anchor: string; + /** + * The param of align. + * + * @type { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + align: T +} + +/** + * Defines the align rule options of relative container. + * + * @interface AlignRuleOption + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface AlignRuleOption { + /** + * The param of left align. + * + * @type { ?AlignRuleParam } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + left?:AlignRuleParam; + + /** + * The param of right align. + * + * @type { ?AlignRuleParam } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + right?: AlignRuleParam; + + /** + * The param of middle align. + * + * @type { ?AlignRuleParam } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + middle?: AlignRuleParam; + + /** + * The param of top align. + * + * @type { ?AlignRuleParam } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + top?: AlignRuleParam; + + /** + * The param of bottom align. + * + * @type { ?AlignRuleParam } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + bottom?: AlignRuleParam; + + /** + * The param of center align. + * + * @type { ?AlignRuleParam } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + center?: AlignRuleParam; + + /** + * Defines the bias ratio in horizontal and vertical direction. + * + * @type { ?Bias } + * @default {horizontal:0.5,vertical:0.5} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + bias?: Bias; +} + + /** * Defines the align rule options of relative container. * @@ -5497,7 +6002,8 @@ declare interface AlignRuleOption { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedHorizontalAlignParam { /** @@ -5507,8 +6013,9 @@ declare interface LocalizedHorizontalAlignParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ anchor: string; /** @@ -5518,8 +6025,9 @@ declare interface LocalizedHorizontalAlignParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ align: HorizontalAlign; } @@ -5530,7 +6038,8 @@ declare interface LocalizedHorizontalAlignParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedVerticalAlignParam { /** @@ -5540,8 +6049,9 @@ declare interface LocalizedVerticalAlignParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ anchor: string; /** @@ -5551,8 +6061,9 @@ declare interface LocalizedVerticalAlignParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ align: VerticalAlign; } @@ -5563,7 +6074,8 @@ declare interface LocalizedVerticalAlignParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedAlignRuleOptions { /** @@ -5573,7 +6085,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: LocalizedHorizontalAlignParam; @@ -5584,7 +6097,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end?: LocalizedHorizontalAlignParam; @@ -5595,7 +6109,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ middle?: LocalizedHorizontalAlignParam; @@ -5606,7 +6121,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: LocalizedVerticalAlignParam; @@ -5617,7 +6133,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: LocalizedVerticalAlignParam; @@ -5628,7 +6145,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ center?: LocalizedVerticalAlignParam; @@ -5640,7 +6158,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bias?: Bias; } @@ -5652,7 +6171,8 @@ declare interface LocalizedAlignRuleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ChainStyle { /** @@ -5661,7 +6181,8 @@ declare enum ChainStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPREAD, @@ -5671,7 +6192,8 @@ declare enum ChainStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPREAD_INSIDE, @@ -5681,7 +6203,8 @@ declare enum ChainStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PACKED, } @@ -5718,7 +6241,8 @@ declare enum ChainStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RotateOptions { /** @@ -5753,7 +6277,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; @@ -5789,7 +6314,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; @@ -5825,7 +6351,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ z?: number; @@ -5861,7 +6388,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerX?: number | string; @@ -5896,7 +6424,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerY?: number | string; @@ -5919,7 +6448,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerZ?: number; @@ -5940,7 +6470,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ perspective?: number; @@ -5976,7 +6507,8 @@ declare interface RotateOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ angle: number | string; } @@ -6055,7 +6587,8 @@ declare interface TransitionOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TransitionEdge { /** @@ -6073,7 +6606,8 @@ declare enum TransitionEdge { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TOP, @@ -6092,7 +6626,8 @@ declare enum TransitionEdge { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM, @@ -6111,7 +6646,8 @@ declare enum TransitionEdge { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START, @@ -6130,7 +6666,8 @@ declare enum TransitionEdge { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END } @@ -6168,13 +6705,53 @@ declare type TransitionEffects = { }; }; +/** + * Defines the option of asymmetric transition. + * + * @interface AsymmetricTransitionOption + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface AsymmetricTransitionOption { + /** + * TransitionEffect used for appearing + * + * @type { TransitionEffect } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + appear: TransitionEffect; + + /** + * TransitionEffect used for disappearing + * + * @type { TransitionEffect } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + disappear: TransitionEffect; +} + /** * Defined the draw modifier of node. Provides draw callbacks for the associated Node. - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DrawModifier { /** @@ -6189,7 +6766,19 @@ declare class DrawModifier { drawBehind?(drawContext: DrawContext): void; /** - * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced + * drawBehind Method. Executed before drawing associated Node. + * + * @param { DrawContext } drawContext - The drawContext used to draw. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + drawBehind(drawContext: DrawContext): void; + + /** + * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced * if this method is set. * * @param { DrawContext } drawContext - The drawContext used to draw. @@ -6199,7 +6788,21 @@ declare class DrawModifier { * @since 12 */ drawContent?(drawContext: DrawContext): void; - + + /** + * drawContent Method. Executed when associated Node is drawing, the default drawContent method will be replaced + * if this method is set. + * + * @param { DrawContext } drawContext - The drawContext used to draw. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + drawContent(drawContext: DrawContext): void; + + /** * drawFront Method. Executed after drawing associated Node. * @@ -6210,14 +6813,27 @@ declare class DrawModifier { * @since 12 */ drawFront?(drawContext: DrawContext): void; - + + /** + * drawFront Method. Executed after drawing associated Node. + * + * @param { DrawContext } drawContext - The drawContext used to draw. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + drawFront(drawContext: DrawContext): void; + /** * Invalidate the component, which will cause a re-render of the component. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ invalidate(): void; } @@ -6333,9 +6949,9 @@ declare class TransitionEffect< >; /** - * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, - * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. - * It comes with default animation parameters, which can also be overridden. + * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, + * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. + * It comes with default animation parameters, which can also be overridden. * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). * * @type { TransitionEffect<"slideSwitch"> } @@ -6347,9 +6963,9 @@ declare class TransitionEffect< * @since 10 */ /** - * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, - * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. - * It comes with default animation parameters, which can also be overridden. + * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, + * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. + * It comes with default animation parameters, which can also be overridden. * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). * * @type { TransitionEffect<"slideSwitch"> } @@ -6390,7 +7006,7 @@ declare class TransitionEffect< * Creates a rotation transition effect * * @param { RotateOptions } options - rotate options - * Set the rotation effect for component transitions when inserting and deleting. + * Set the rotation effect for component transitions when inserting and deleting. * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. * -x: Horizontal component of the rotational vector. * -y: Vertical component of the rotational vector. @@ -6410,7 +7026,7 @@ declare class TransitionEffect< * Creates a rotation transition effect * * @param { RotateOptions } options - rotate options - * Set the rotation effect for component transitions when inserting and deleting. + * Set the rotation effect for component transitions when inserting and deleting. * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. * -x: Horizontal component of the rotational vector. * -y: Vertical component of the rotational vector. @@ -6609,43 +7225,347 @@ declare class TransitionEffect< } /** - * Define Preview property - * - * @interface PreviewParams - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @form - * @since 9 - */ -/** - * Define Preview property + * Defines the transition effect * - * @interface PreviewParams * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice - * @since 11 + * @since 20 + * @arkts 1.2 */ -interface PreviewParams { +declare class TransitionEffect { + /** - * Define Preview title + * Disables the transition effect * - * @type { ?string } + * @type { TransitionEffect } + * @readonly + * @static * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform * @form - * @since 9 + * @atomicservice + * @since 20 + * @arkts 1.2 */ + static readonly IDENTITY: TransitionEffect; + /** - * Define Preview title + * Specifies a transition effect with transparency of 0, which is equivalent to TransitionEffect.opacity(0). * - * @type { ?string } + * @type { TransitionEffect } + * @readonly + * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice - * @since 11 + * @since 20 + * @arkts 1.2 */ - title?: string; + static readonly OPACITY: TransitionEffect; + + /** + * Defines a slide transition effect + * + * @type { TransitionEffect } + * @readonly + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static readonly SLIDE: TransitionEffect; + + /** + * Specify a transition effect where the element enters by shrinking first and then expanding as it slides in from the right, + * and exits by shrinking first and then expanding as it slides out to the left, with a minimum scale ratio of 0.8. + * It comes with default animation parameters, which can also be overridden. + * The default animation duration is set to 600ms, and the specified animation curve is cubicBezierCurve(0.24, 0.0, 0.50, 1.0). + * + * @type { TransitionEffect } + * @readonly + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static readonly SLIDE_SWITCH: TransitionEffect; + + /** + * Creates a translate transition effect + * + * @param { TranslateOptions } options - translate options + * @returns { TransitionEffect } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static translate(options: TranslateOptions): TransitionEffect; + + /** + * Creates a rotation transition effect + * + * @param { RotateOptions } options - rotate options + * Set the rotation effect for component transitions when inserting and deleting. + * The value represents the starting rotation point for the inserting animation and the ending rotation point for the deleting animation. + * -x: Horizontal component of the rotational vector. + * -y: Vertical component of the rotational vector. + * -z: Vertical component of the rotational vector. + * -centerX, centerY specify the rotation center point, with default values of "50%", + * meaning that the default rotation center point is the center point of the component. + * -The center point of (0, 0) represents the upper-left corner of the component. + * -centerZ refers to the Z-axis anchor point. The default value of centerZ is 0. + * -perspective indicates the visual distance. The perspective property does not support transition animation. + * @returns { TransitionEffect } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static rotate(options: RotateOptions): TransitionEffect; + + /** + * Creates a scale transition effect + * + * @param { ScaleOptions } options - scale options + * @returns { TransitionEffect } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static scale(options: ScaleOptions): TransitionEffect; + + /** + * Creates an opacity transition effect with alpha value + * + * @param { number } alpha - opacity alpha value, value range [0, 1]. + * Illegal values less than 0 are treated as 0, and illegal values greater than 1 are treated as 1. + * @returns { TransitionEffect } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static opacity(alpha: number): TransitionEffect; + + /** + * Creates a move transition effect + * + * @param { TransitionEdge } edge - the edge that component will move to + * @returns { TransitionEffect } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static move(edge: TransitionEdge): TransitionEffect; + + /** + * Creates an asymmetric transition effect + * + * @param { TransitionEffect } appear - the transition which will be attached when the component is appear + * @param { TransitionEffect } disappear - the transition which will be attached when the component is disappear + * @returns { TransitionEffect } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + static asymmetric(appear: TransitionEffect, disappear: TransitionEffect): TransitionEffect; + + /** + * identity or slideSwitch TransitionEffect constructor + * + * @param { 'identity' | 'slideSwitch' } type - transition type + * @param { undefined } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'identity' | 'slideSwitch', effect: undefined); + + /** + * opacity TransitionEffect constructor + * + * @param { 'opacity' } type - transition type + * @param { number } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'opacity', effect: number); + + /** + * move TransitionEffect constructor + * + * @param { 'move' } type - transition type + * @param { TransitionEdge } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'move', effect: TransitionEdge); + + /** + * translate TransitionEffect constructor + * + * @param { 'translate' } type - transition type + * @param { TranslateOptions } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'translate', effect:TranslateOptions); + + /** + * rotate TransitionEffect constructor + * + * @param { 'rotate' } type - transition type + * @param { RotateOptions } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'rotate', effect: RotateOptions); + + /** + * scale TransitionEffect constructor + * + * @param { 'scale' } type - transition type + * @param { ScaleOptions } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'scale', effect: ScaleOptions); + + /** + * asymmetric TransitionEffect constructor + * + * @param { 'asymmetric' } type - transition type + * @param { AsymmetricTransitionOption } effect - transition options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(type: 'asymmetric', effect: AsymmetricTransitionOption); + + /** + * Set the animation of current transition effect + * + * @param { AnimateParam } value - animation parameters + * @returns { TransitionEffect } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + animation(value: AnimateParam): TransitionEffect; + + /** + * Combines another transition effect + * + * @param { TransitionEffect } transitionEffect - transition effect which is be combined + * @returns { TransitionEffect } combined transition effect + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + combine(transitionEffect: TransitionEffect): TransitionEffect; +} + +/** + * Define Preview property + * + * @interface PreviewParams + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @form + * @since 9 + */ +/** + * Define Preview property + * + * @interface PreviewParams + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 11 + */ +interface PreviewParams { + /** + * Define Preview title + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @form + * @since 9 + */ + /** + * Define Preview title + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 11 + */ + title?: string; /** * Define Preview width @@ -6825,7 +7745,8 @@ interface PreviewParams { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ItemDragInfo { /** @@ -6850,7 +7771,8 @@ declare interface ItemDragInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -6876,7 +7798,8 @@ declare interface ItemDragInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -6887,7 +7810,8 @@ declare interface ItemDragInfo { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EffectType { /** @@ -6895,7 +7819,8 @@ declare enum EffectType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, /** @@ -6903,7 +7828,8 @@ declare enum EffectType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW_EFFECT = 1, } @@ -6914,7 +7840,8 @@ declare enum EffectType { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PreDragStatus { /** @@ -6922,7 +7849,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_DETECTING_STATUS = 0, @@ -6931,7 +7859,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ READY_TO_TRIGGER_DRAG_ACTION = 1, @@ -6940,7 +7869,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW_LIFT_STARTED = 2, @@ -6949,7 +7879,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW_LIFT_FINISHED = 3, @@ -6958,7 +7889,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW_LANDING_STARTED = 4, @@ -6967,7 +7899,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW_LANDING_FINISHED = 5, @@ -6976,7 +7909,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_CANCELED_BEFORE_DRAG = 6, @@ -6985,7 +7919,8 @@ declare enum PreDragStatus { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PREPARING_FOR_DRAG_DETECTION = 7, } @@ -7012,7 +7947,8 @@ declare enum PreDragStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DragItemInfo { /** @@ -7037,7 +7973,8 @@ declare interface DragItemInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts{'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ pixelMap?: PixelMap; @@ -7063,7 +8000,8 @@ declare interface DragItemInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ builder?: CustomBuilder; @@ -7089,7 +8027,8 @@ declare interface DragItemInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ extraInfo?: string; } @@ -7130,7 +8069,8 @@ declare interface DragItemInfo { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 18 * @useinstead ohos.arkui.UIContext.UIContext#animateTo */ @@ -7144,7 +8084,8 @@ declare function animateTo(value: AnimateParam, event: () => void): void; * and the system will automatically insert transition animations for state changes caused by the closure function. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare function animateToImmediately(value: AnimateParam, event: () => void): void; @@ -7184,7 +8125,8 @@ declare function animateToImmediately(value: AnimateParam, event: () => void): v * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 18 * @useinstead ohos.arkui.UIContext.UIContext#vp2px */ @@ -7226,7 +8168,8 @@ declare function vp2px(value: number): number; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 18 * @useinstead ohos.arkui.UIContext.UIContext#px2vp */ @@ -7417,7 +8360,8 @@ declare function px2lpx(value: number): number; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace focusControl { /** @@ -7445,7 +8389,8 @@ declare namespace focusControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function requestFocus(value: string): boolean; } @@ -7467,6 +8412,17 @@ declare namespace focusControl { */ declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').default.PointerStyle; +/** + * Import the PointerStyle type object for setCursor. + * + * @typedef { pointer.PointerStyle } PointerStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type PointerStyle = pointer.PointerStyle; + /** * CursorControl * @@ -7480,7 +8436,8 @@ declare type PointerStyle = import('../api/@ohos.multimodalInput.pointer').defau * @namespace cursorControl * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace cursorControl { @@ -7499,7 +8456,8 @@ declare namespace cursorControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function setCursor(value: PointerStyle): void; @@ -7516,7 +8474,8 @@ declare namespace cursorControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function restoreDefault(): void; } @@ -7553,7 +8512,8 @@ declare namespace cursorControl { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface EventTarget { /** @@ -7588,7 +8548,8 @@ declare interface EventTarget { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ area: Area; @@ -7600,7 +8561,8 @@ declare interface EventTarget { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ id?: string; } @@ -7627,7 +8589,8 @@ declare interface EventTarget { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SourceType { /** @@ -7649,7 +8612,8 @@ declare enum SourceType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Unknown, @@ -7672,7 +8636,8 @@ declare enum SourceType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Mouse, @@ -7695,7 +8660,8 @@ declare enum SourceType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TouchScreen, } @@ -7722,7 +8688,8 @@ declare enum SourceType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SourceTool { /** @@ -7744,7 +8711,8 @@ declare enum SourceTool { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Unknown, @@ -7767,7 +8735,8 @@ declare enum SourceTool { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Finger, @@ -7790,7 +8759,8 @@ declare enum SourceTool { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Pen, @@ -7800,7 +8770,8 @@ declare enum SourceTool { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MOUSE, @@ -7810,7 +8781,8 @@ declare enum SourceTool { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOUCHPAD, @@ -7820,7 +8792,8 @@ declare enum SourceTool { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ JOYSTICK, } @@ -7850,7 +8823,8 @@ declare enum SourceTool { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RepeatMode { /** @@ -7875,7 +8849,8 @@ declare enum RepeatMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Repeat, @@ -7901,7 +8876,8 @@ declare enum RepeatMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Stretch, @@ -7927,7 +8903,8 @@ declare enum RepeatMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Round, @@ -7953,7 +8930,8 @@ declare enum RepeatMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Space, } @@ -7983,7 +8961,8 @@ declare enum RepeatMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BlurStyle { /** @@ -8008,7 +8987,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Thin, @@ -8034,7 +9014,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Regular, @@ -8060,7 +9041,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Thick, @@ -8078,7 +9060,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND_THIN, @@ -8096,7 +9079,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND_REGULAR, @@ -8114,7 +9098,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND_THICK, @@ -8132,7 +9117,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND_ULTRA_THICK, @@ -8151,9 +9137,10 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 11 - */ - NONE, + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + NONE, /** * Defines the ultra thin component material. @@ -8170,7 +9157,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPONENT_ULTRA_THIN = 8, @@ -8189,7 +9177,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPONENT_THIN = 9, @@ -8208,7 +9197,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPONENT_REGULAR = 10, @@ -8227,7 +9217,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPONENT_THICK = 11, @@ -8246,7 +9237,8 @@ declare enum BlurStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPONENT_ULTRA_THICK = 12, } @@ -8258,7 +9250,8 @@ declare enum BlurStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BlurStyleActivePolicy { /** @@ -8267,7 +9260,8 @@ declare enum BlurStyleActivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ FOLLOWS_WINDOW_ACTIVE_STATE = 0, @@ -8277,7 +9271,8 @@ declare enum BlurStyleActivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ALWAYS_ACTIVE = 1, @@ -8287,7 +9282,8 @@ declare enum BlurStyleActivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ALWAYS_INACTIVE = 2, } @@ -8307,7 +9303,8 @@ declare enum BlurStyleActivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ThemeColorMode { /** @@ -8323,7 +9320,8 @@ declare enum ThemeColorMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM, @@ -8340,7 +9338,8 @@ declare enum ThemeColorMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHT, @@ -8357,7 +9356,8 @@ declare enum ThemeColorMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DARK, } @@ -8377,7 +9377,8 @@ declare enum ThemeColorMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AdaptiveColor { /** @@ -8393,7 +9394,8 @@ declare enum AdaptiveColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT, @@ -8410,7 +9412,8 @@ declare enum AdaptiveColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AVERAGE, } @@ -8430,7 +9433,8 @@ declare enum AdaptiveColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ModalTransition { /** @@ -8446,7 +9450,8 @@ declare enum ModalTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT, @@ -8463,7 +9468,8 @@ declare enum ModalTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE, @@ -8480,7 +9486,8 @@ declare enum ModalTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ALPHA, } @@ -8502,7 +9509,8 @@ declare enum ModalTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { /** @@ -8513,7 +9521,8 @@ declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ policy?: BlurStyleActivePolicy; @@ -8525,7 +9534,8 @@ declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ inactiveColor?: ResourceColor; } @@ -8547,7 +9557,8 @@ declare interface BackgroundBlurStyleOptions extends BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} @@ -8567,7 +9578,8 @@ declare interface ForegroundBlurStyleOptions extends BlurStyleOptions {} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BlurOptions { /** @@ -8583,7 +9595,8 @@ declare interface BlurOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ grayscale: [number, number]; } @@ -8596,18 +9609,20 @@ declare interface BlurOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SystemAdaptiveOptions { /** * Whether to disable system adaptive. - * + * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ disableSystemAdaptation?: boolean; } @@ -8627,7 +9642,8 @@ declare interface SystemAdaptiveOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BlurStyleOptions { /** @@ -8646,7 +9662,8 @@ declare interface BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ colorMode?: ThemeColorMode; @@ -8666,7 +9683,8 @@ declare interface BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ adaptiveColor?: AdaptiveColor; @@ -8679,7 +9697,8 @@ declare interface BlurStyleOptions { * @default 1.0 * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scale?: number; @@ -8700,7 +9719,8 @@ declare interface BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ blurOptions?: BlurOptions; } @@ -8720,7 +9740,8 @@ declare interface BlurStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BackgroundEffectOptions { @@ -8739,7 +9760,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius: number; @@ -8760,7 +9782,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ saturation?: number; @@ -8781,7 +9804,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ brightness?: number; @@ -8802,7 +9826,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -8823,7 +9848,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ adaptiveColor?: AdaptiveColor; @@ -8844,7 +9870,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ blurOptions?: BlurOptions; @@ -8856,7 +9883,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ policy?: BlurStyleActivePolicy; @@ -8868,7 +9896,8 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ inactiveColor?: ResourceColor; } @@ -8880,10 +9909,11 @@ declare interface BackgroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ForegroundEffectOptions { - + /** * Define the radius size of ForegroundEffect.The range of this value is [0, ∞) * @@ -8891,7 +9921,8 @@ declare interface ForegroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius: number; } @@ -8911,7 +9942,8 @@ declare interface ForegroundEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PickerTextStyle { /** @@ -8929,7 +9961,8 @@ declare interface PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -8950,7 +9983,8 @@ declare interface PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ font?: Font; } @@ -8962,7 +9996,8 @@ declare interface PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PickerDialogButtonStyle { /** @@ -8972,7 +10007,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type?: ButtonType; @@ -8983,7 +10019,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: ButtonStyleMode; @@ -8994,7 +10031,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ role?: ButtonRole; @@ -9005,7 +10043,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: Length; @@ -9016,7 +10055,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; @@ -9027,7 +10067,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: FontWeight | number | string; @@ -9038,7 +10079,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle?: FontStyle; @@ -9049,7 +10091,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily?: Resource | string; @@ -9060,7 +10103,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -9071,7 +10115,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius?: Length | BorderRadiuses; @@ -9082,7 +10127,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ primary?: boolean; } @@ -9102,7 +10148,8 @@ declare interface PickerDialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ShadowType { /** @@ -9118,7 +10165,8 @@ declare enum ShadowType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR, @@ -9135,7 +10183,8 @@ declare enum ShadowType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BLUR, } @@ -9172,7 +10221,8 @@ declare enum ShadowType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ShadowOptions { /** @@ -9207,7 +10257,8 @@ declare interface ShadowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radius: number | Resource; @@ -9228,7 +10279,8 @@ declare interface ShadowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type?: ShadowType; @@ -9264,7 +10316,8 @@ declare interface ShadowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color?: Color | string | Resource | ColoringStrategy; @@ -9300,7 +10353,8 @@ declare interface ShadowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetX?: number | Resource; @@ -9336,7 +10390,8 @@ declare interface ShadowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetY?: number | Resource; @@ -9357,7 +10412,8 @@ declare interface ShadowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fill?: boolean; } @@ -9377,7 +10433,8 @@ declare interface ShadowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ShadowStyle { /** @@ -9393,7 +10450,8 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OUTER_DEFAULT_XS, @@ -9410,7 +10468,8 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OUTER_DEFAULT_SM, @@ -9427,7 +10486,8 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OUTER_DEFAULT_MD, @@ -9444,7 +10504,8 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OUTER_DEFAULT_LG, @@ -9461,7 +10522,8 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OUTER_FLOATING_SM, @@ -9478,7 +10540,8 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OUTER_FLOATING_MD, } @@ -9498,12 +10561,13 @@ declare enum ShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MultiShadowOptions { /** * Current shadow radius. - * + * * @type { ?(number | Resource) } * @default 5 * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -9512,19 +10576,20 @@ declare interface MultiShadowOptions { */ /** * Current shadow radius. - * + * * @type { ?(number | Resource) } * @default 20 * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: number | Resource; /** * Current shadow offsetX. - * + * * @type { ?(number | Resource) } * @default 5 * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -9533,19 +10598,20 @@ declare interface MultiShadowOptions { */ /** * Current shadow offsetX. - * + * * @type { ?(number | Resource) } * @default 5 * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetX?: number | Resource; /** * Current shadow offsetY - * + * * @type { ?(number | Resource) } * @default 5 * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -9554,13 +10620,14 @@ declare interface MultiShadowOptions { */ /** * Current shadow offsetY - * + * * @type { ?(number | Resource) } * @default 5 * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetY?: number | Resource; } @@ -9579,7 +10646,8 @@ declare interface MultiShadowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SafeAreaType { /** @@ -9594,7 +10662,8 @@ declare enum SafeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM, @@ -9610,7 +10679,8 @@ declare enum SafeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CUTOUT, @@ -9626,7 +10696,8 @@ declare enum SafeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ KEYBOARD } @@ -9645,7 +10716,8 @@ declare enum SafeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SafeAreaEdge { /** @@ -9660,7 +10732,8 @@ declare enum SafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TOP, @@ -9676,7 +10749,8 @@ declare enum SafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM, @@ -9692,7 +10766,8 @@ declare enum SafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START, @@ -9708,7 +10783,8 @@ declare enum SafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END } @@ -9720,7 +10796,8 @@ declare enum SafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LayoutSafeAreaType { /** @@ -9729,7 +10806,8 @@ declare enum LayoutSafeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM = 0, } @@ -9741,7 +10819,8 @@ declare enum LayoutSafeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LayoutSafeAreaEdge { /** @@ -9750,7 +10829,8 @@ declare enum LayoutSafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP = 0, @@ -9760,7 +10840,8 @@ declare enum LayoutSafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM = 1, } @@ -9780,7 +10861,8 @@ declare enum LayoutSafeAreaEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SheetSize { /** @@ -9796,7 +10878,8 @@ declare enum SheetSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIUM, @@ -9813,7 +10896,8 @@ declare enum SheetSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LARGE, @@ -9830,11 +10914,26 @@ declare enum SheetSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FIT_CONTENT = 2, } +/** + * The modifier key state query function block. + * + * @typedef { function } ModifierKeyStateGetter + * @param { Array } keys - Indicate the modifier keys to query. + * @returns { boolean } - the query result + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type ModifierKeyStateGetter = (keys: Array) => boolean; + /** * Defines the base event. * @@ -9867,7 +10966,8 @@ declare enum SheetSize { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BaseEvent { /** @@ -9902,7 +11002,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ target: EventTarget; @@ -9938,7 +11039,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; @@ -9974,7 +11076,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ source: SourceType; @@ -9986,7 +11089,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ axisHorizontal?: number; @@ -9998,7 +11102,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ axisVertical?: number; @@ -10027,7 +11132,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pressure: number; @@ -10056,7 +11162,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ tiltX: number; @@ -10085,7 +11192,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ tiltY: number; @@ -10097,7 +11205,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ rollAngle?: number; @@ -10126,7 +11235,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sourceTool: SourceTool; @@ -10143,6 +11253,18 @@ declare interface BaseEvent { */ getModifierKeyState?(keys: Array): boolean; + /** + * Query the modifier key press state, support 'ctrl'|'alt'|'shift' + * + * @type { ?ModifierKeyStateGetter } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + getModifierKeyState?: ModifierKeyStateGetter; + /** * Indicates the ID of the input device that triggers the current event. * @@ -10150,7 +11272,8 @@ declare interface BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId?: number; @@ -10161,7 +11284,8 @@ declare interface BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ targetDisplayId?: number; } @@ -10191,7 +11315,8 @@ declare interface BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BorderImageOption { /** @@ -10229,7 +11354,8 @@ declare interface BorderImageOption { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ slice?: Length | EdgeWidths | LocalizedEdgeWidths, @@ -10258,7 +11384,8 @@ declare interface BorderImageOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ repeat?: RepeatMode, @@ -10291,6 +11418,19 @@ declare interface BorderImageOption { */ source?: string | Resource | LinearGradient, + /** + * Border image source + * + * @type { ?(string | Resource | LinearGradientOptions) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + source?: string | Resource | LinearGradientOptions, + /** * Border image width * @@ -10326,7 +11466,8 @@ declare interface BorderImageOption { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Length | EdgeWidths | LocalizedEdgeWidths, @@ -10365,7 +11506,8 @@ declare interface BorderImageOption { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ outset?: Length | EdgeWidths | LocalizedEdgeWidths, @@ -10394,7 +11536,8 @@ declare interface BorderImageOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fill?: boolean } @@ -10406,7 +11549,8 @@ declare interface BorderImageOption { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LayoutPolicy { /** @@ -10418,8 +11562,9 @@ declare class LayoutPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form - * @atomicservice - * @since 15 + * @atomicservice + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly matchParent: LayoutPolicy; } @@ -10460,7 +11605,8 @@ declare class LayoutPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ClickEvent extends BaseEvent { /** @@ -10478,7 +11624,8 @@ declare interface ClickEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayX: number; @@ -10497,7 +11644,8 @@ declare interface ClickEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayY: number; @@ -10516,7 +11664,8 @@ declare interface ClickEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -10535,7 +11684,8 @@ declare interface ClickEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -10593,7 +11743,8 @@ declare interface ClickEvent extends BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -10629,7 +11780,8 @@ declare interface ClickEvent extends BaseEvent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -10640,7 +11792,8 @@ declare interface ClickEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ hand?: InteractionHand; @@ -10651,7 +11804,8 @@ declare interface ClickEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preventDefault: () => void; } @@ -10671,7 +11825,8 @@ declare interface ClickEvent extends BaseEvent { * @interface HoverEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface HoverEvent extends BaseEvent { /** @@ -10680,7 +11835,8 @@ declare interface HoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; @@ -10690,7 +11846,8 @@ declare interface HoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; @@ -10700,7 +11857,8 @@ declare interface HoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ windowX?: number; @@ -10710,7 +11868,8 @@ declare interface HoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ windowY?: number; @@ -10720,7 +11879,8 @@ declare interface HoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ displayX?: number; @@ -10730,7 +11890,8 @@ declare interface HoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ displayY?: number; @@ -10747,7 +11908,8 @@ declare interface HoverEvent extends BaseEvent { * @type { function } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stopPropagation: () => void; } @@ -10767,7 +11929,8 @@ declare interface HoverEvent extends BaseEvent { * @interface MouseEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MouseEvent extends BaseEvent { /** @@ -10783,7 +11946,8 @@ declare interface MouseEvent extends BaseEvent { * @type { MouseButton } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ button: MouseButton; @@ -10800,7 +11964,8 @@ declare interface MouseEvent extends BaseEvent { * @type { MouseAction } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ action: MouseAction; @@ -10817,7 +11982,8 @@ declare interface MouseEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayX: number; @@ -10834,7 +12000,8 @@ declare interface MouseEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayY: number; @@ -10851,7 +12018,8 @@ declare interface MouseEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -10868,7 +12036,8 @@ declare interface MouseEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -10907,7 +12076,8 @@ declare interface MouseEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -10924,7 +12094,8 @@ declare interface MouseEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -10941,7 +12112,8 @@ declare interface MouseEvent extends BaseEvent { * @type { function } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stopPropagation: () => void; @@ -10952,7 +12124,8 @@ declare interface MouseEvent extends BaseEvent { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ rawDeltaX?: number; @@ -10963,17 +12136,19 @@ declare interface MouseEvent extends BaseEvent { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ rawDeltaY?: number; - + /** * The pressed buttons of the mouse event. * * @type { ?MouseButton[] } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ pressedButtons?: MouseButton[]; } @@ -10985,7 +12160,8 @@ declare interface MouseEvent extends BaseEvent { * @typedef AccessibilityHoverEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AccessibilityHoverEvent extends BaseEvent { /** @@ -10994,7 +12170,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { AccessibilityHoverType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: AccessibilityHoverType; @@ -11004,7 +12181,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -11014,7 +12192,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -11024,7 +12203,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ displayX: number; @@ -11034,7 +12214,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ displayY: number; @@ -11044,7 +12225,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -11054,7 +12236,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; } @@ -11081,7 +12264,8 @@ declare interface AccessibilityHoverEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TouchObject { /** @@ -11106,7 +12290,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: TouchType; @@ -11132,7 +12317,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -11151,7 +12337,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayX: number; @@ -11170,7 +12357,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayY: number; @@ -11189,7 +12377,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -11208,7 +12397,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -11256,7 +12446,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -11282,7 +12473,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -11293,7 +12485,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ hand?: InteractionHand; @@ -11304,7 +12497,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ pressedTime?: number; /** @@ -11314,7 +12508,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ pressure?: number; @@ -11325,7 +12520,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ width?: number; @@ -11336,7 +12532,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number; } @@ -11356,7 +12553,8 @@ declare interface TouchObject { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface HistoricalPoint { /** @@ -11374,7 +12572,8 @@ declare interface HistoricalPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ touchObject: TouchObject; @@ -11393,7 +12592,8 @@ declare interface HistoricalPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size: number; @@ -11412,7 +12612,8 @@ declare interface HistoricalPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ force: number; @@ -11431,7 +12632,8 @@ declare interface HistoricalPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; } @@ -11461,7 +12663,8 @@ declare interface HistoricalPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TouchEvent extends BaseEvent { /** @@ -11486,7 +12689,8 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: TouchType; @@ -11512,7 +12716,8 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ touches: TouchObject[]; @@ -11538,7 +12743,8 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ changedTouches: TouchObject[]; @@ -11564,7 +12770,8 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stopPropagation: () => void; @@ -11583,7 +12790,8 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getHistoricalPoints(): Array; @@ -11594,7 +12802,8 @@ declare interface TouchEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preventDefault: () => void; } @@ -11606,7 +12815,8 @@ declare interface TouchEvent extends BaseEvent { * @interface AxisEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AxisEvent extends BaseEvent { /** @@ -11615,7 +12825,8 @@ declare interface AxisEvent extends BaseEvent { * @type { AxisAction } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ action: AxisAction; @@ -11625,7 +12836,8 @@ declare interface AxisEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ displayX: number; @@ -11635,7 +12847,8 @@ declare interface AxisEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ displayY: number; @@ -11645,7 +12858,8 @@ declare interface AxisEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -11655,7 +12869,8 @@ declare interface AxisEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -11665,7 +12880,8 @@ declare interface AxisEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -11675,7 +12891,8 @@ declare interface AxisEvent extends BaseEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -11685,7 +12902,8 @@ declare interface AxisEvent extends BaseEvent { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ scrollStep?: number; @@ -11695,7 +12913,8 @@ declare interface AxisEvent extends BaseEvent { * @type { Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ propagation: Callback; @@ -11705,7 +12924,8 @@ declare interface AxisEvent extends BaseEvent { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getHorizontalAxisValue(): number; @@ -11715,7 +12935,8 @@ declare interface AxisEvent extends BaseEvent { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getVerticalAxisValue(): number; } @@ -11730,7 +12951,8 @@ declare interface AxisEvent extends BaseEvent { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) => void; @@ -11745,7 +12967,8 @@ declare type SizeChangeCallback = (oldValue: SizeOptions, newValue: SizeOptions) * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, current: GestureRecognizer, recognizers: Array) => GestureJudgeResult; @@ -11759,20 +12982,22 @@ declare type GestureRecognizerJudgeBeginCallback = (event: BaseGestureEvent, cur * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ShouldBuiltInRecognizerParallelWithCallback = (current: GestureRecognizer, others: Array) => GestureRecognizer; /** * Defines the finish callback type used in transition. - * + * * @typedef { function } TransitionFinishCallback * @param { boolean } transitionIn - a boolean value indicates whether it is the callback of transitionIn or transitionOut. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type TransitionFinishCallback = (transitionIn: boolean) => void; @@ -11800,13 +13025,26 @@ declare type TransitionFinishCallback = (transitionIn: boolean) => void; */ declare type PixelMap = import('../api/@ohos.multimedia.image').default.PixelMap; +/** + * Defines the PixelMap type object for ui component. + * + * @typedef { image.PixelMap } PixelMap + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type PixelMap = image.PixelMap; + /** * pixelmap object with release function. * * @interface PixelMapMock * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PixelMapMock { /** @@ -11814,7 +13052,8 @@ declare interface PixelMapMock { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ release(): void; } @@ -11841,7 +13080,8 @@ declare interface PixelMapMock { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DragBehavior { /** @@ -11863,7 +13103,8 @@ declare enum DragBehavior { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ COPY, /** @@ -11885,7 +13126,8 @@ declare enum DragBehavior { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MOVE } @@ -11909,6 +13151,18 @@ declare enum DragBehavior { */ declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').default.UnifiedData; +/** + * Import the UnifiedData type object for ui component. + * + * @typedef { unifiedDataChannel.UnifiedData } UnifiedData + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type UnifiedData = unifiedDataChannel.UnifiedData; + /** * Import the Summary type object for ui component. * @@ -11926,6 +13180,17 @@ declare type UnifiedData = import('../api/@ohos.data.unifiedDataChannel').defaul */ declare type Summary = import('../api/@ohos.data.unifiedDataChannel').default.Summary; +/** + * Import the Summary type object for ui component. + * + * @typedef { unifiedDataChannel.Summary } Summary + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type Summary = unifiedDataChannel.Summary; + /** * Import the UniformDataType type object for ui component. * @@ -11954,6 +13219,17 @@ declare type UniformDataType = import('../api/@ohos.data.uniformTypeDescriptor') */ declare type DataSyncOptions = import('../api/@ohos.data.unifiedDataChannel').default.GetDataParams; +/** + * Import the UniformDataType type object for ui component. + * + * @typedef { uniformTypeDescriptor.UniformDataType } UniformDataType + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type UniformDataType = uniformTypeDescriptor.UniformDataType; + /** * Enum for Drag Result. * @@ -11976,9 +13252,20 @@ declare type DataSyncOptions = import('../api/@ohos.data.unifiedDataChannel').de * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DragResult { + /** + * If the drag is not finished and the result is not set by receiver, return DragResult.UNKNOWN. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + UNKNOWN = -1, /** * If the drag is successful, return DragResult.DRAG_SUCCESSFUL. * @@ -11998,7 +13285,8 @@ declare enum DragResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ DRAG_SUCCESSFUL = 0, /** @@ -12020,7 +13308,8 @@ declare enum DragResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ DRAG_FAILED = 1, /** @@ -12034,7 +13323,8 @@ declare enum DragResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DRAG_CANCELED = 2, /** @@ -12048,7 +13338,8 @@ declare enum DragResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DROP_ENABLED = 3, /** @@ -12062,14 +13353,15 @@ declare enum DragResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DROP_DISABLED = 4 } /** * Enum for BlendMode. - * Blend modes for compositing current component + * Blend modes for compositing current component * with overlapping content. Use overlapping content * as dst, current component as src. * @@ -12090,7 +13382,8 @@ declare enum DragResult { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BlendMode { /** @@ -12108,7 +13401,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, /** @@ -12126,7 +13420,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CLEAR = 1, /** @@ -12144,7 +13439,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SRC = 2, /** @@ -12162,7 +13458,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DST = 3, /** @@ -12180,7 +13477,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SRC_OVER = 4, /** @@ -12198,7 +13496,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DST_OVER = 5, /** @@ -12216,7 +13515,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SRC_IN = 6, /** @@ -12234,7 +13534,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DST_IN = 7, /** @@ -12252,7 +13553,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SRC_OUT = 8, /** @@ -12270,7 +13572,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DST_OUT = 9, /** @@ -12288,7 +13591,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SRC_ATOP = 10, /** @@ -12306,7 +13610,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DST_ATOP = 11, /** @@ -12324,7 +13629,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ XOR = 12, /** @@ -12342,7 +13648,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLUS = 13, /** @@ -12360,7 +13667,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MODULATE = 14, /** @@ -12378,7 +13686,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN = 15, /** @@ -12396,7 +13705,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OVERLAY = 16, /** @@ -12414,7 +13724,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DARKEN = 17, /** @@ -12432,7 +13743,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHTEN = 18, /** @@ -12450,7 +13762,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_DODGE = 19, /** @@ -12468,7 +13781,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_BURN = 20, /** @@ -12486,7 +13800,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HARD_LIGHT = 21, /** @@ -12504,7 +13819,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOFT_LIGHT = 22, /** @@ -12522,7 +13838,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DIFFERENCE = 23, /** @@ -12540,7 +13857,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXCLUSION = 24, /** @@ -12558,7 +13876,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MULTIPLY = 25, /** @@ -12576,7 +13895,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HUE = 26, /** @@ -12594,7 +13914,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATURATION = 27, /** @@ -12612,7 +13933,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR = 28, /** @@ -12630,7 +13952,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LUMINOSITY = 29 } @@ -12656,7 +13979,8 @@ declare enum BlendMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BlendApplyType { /** @@ -12674,7 +13998,8 @@ declare enum BlendApplyType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FAST = 0, @@ -12695,7 +14020,8 @@ declare enum BlendApplyType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OFFSCREEN = 1, } @@ -12722,7 +14048,8 @@ declare enum BlendApplyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DragEvent { /** @@ -12747,7 +14074,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getDisplayX(): number; @@ -12773,7 +14101,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getDisplayY(): number; @@ -12799,7 +14128,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getWindowX(): number; @@ -12825,7 +14155,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getWindowY(): number; @@ -12873,7 +14204,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ dragBehavior: DragBehavior; @@ -12890,7 +14222,8 @@ declare interface DragEvent { * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ useCustomDropAnimation: boolean; @@ -12909,7 +14242,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setData(unifiedData: UnifiedData): void; @@ -12932,7 +14266,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getData(): UnifiedData; @@ -12951,7 +14286,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getSummary(): Summary; @@ -12977,7 +14313,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ setResult(dragResult: DragResult): void; @@ -13003,7 +14340,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getResult(): DragResult; @@ -13029,7 +14367,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getPreviewRect(): Rectangle; @@ -13048,7 +14387,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getVelocityX(): number; @@ -13067,7 +14407,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getVelocityY(): number; @@ -13086,7 +14427,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getVelocity(): number; @@ -13113,6 +14455,18 @@ declare interface DragEvent { */ getModifierKeyState?(keys: Array): boolean; + /** + * Query the modifier key press state, support 'ctrl'|'alt'|'shift' + * + * @type { ?ModifierKeyStateGetter } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + getModifierKeyState?: ModifierKeyStateGetter; + /** * Setup one drop animation execution callback, which will be triggered by system when user drops. * Use this way to implement the custom drop animation instead of doing it in onDrop, as the system @@ -13125,7 +14479,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ executeDropAnimation(customDropAnimation: Callback): void; @@ -13152,7 +14507,8 @@ declare interface DragEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnDragEventCallback = (event: DragEvent, extraParams?: string) => void; @@ -13163,7 +14519,8 @@ declare type OnDragEventCallback = (event: DragEvent, extraParams?: string) => v * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DropOptions { @@ -13181,7 +14538,8 @@ declare interface DropOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ disableDataPrefetch?: boolean; } @@ -13225,7 +14583,8 @@ declare type IntentionCode = import('../api/@ohos.multimodalInput.intentionCode' * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface KeyEvent { /** @@ -13250,7 +14609,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: KeyType; @@ -13276,7 +14636,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ keyCode: number; @@ -13302,7 +14663,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ keyText: string; @@ -13328,7 +14690,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ keySource: KeySource; @@ -13354,7 +14717,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: number; @@ -13383,7 +14747,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ metaKey: number; @@ -13409,7 +14774,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; @@ -13435,7 +14801,8 @@ declare interface KeyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stopPropagation: () => void; @@ -13454,7 +14821,8 @@ declare interface KeyEvent { * @default IntentionCode.INTENTION_UNKNOWN * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ intentionCode: IntentionCode; @@ -13481,13 +14849,26 @@ declare interface KeyEvent { */ getModifierKeyState?(keys: Array): boolean; + /** + * Query the modifier key press state, support 'ctrl'|'alt'|'shift' + * + * @type { ?ModifierKeyStateGetter } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + getModifierKeyState?: ModifierKeyStateGetter; + /** * Unicode of a key * * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ unicode?: number; } @@ -13499,7 +14880,8 @@ declare interface KeyEvent { * @interface FocusAxisEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FocusAxisEvent extends BaseEvent { /** @@ -13508,7 +14890,8 @@ declare interface FocusAxisEvent extends BaseEvent { * @type { Map } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ axisMap: Map; @@ -13518,7 +14901,8 @@ declare interface FocusAxisEvent extends BaseEvent { * @type { Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ stopPropagation: Callback; } @@ -13529,7 +14913,8 @@ declare interface FocusAxisEvent extends BaseEvent { * @interface CrownEvent * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CrownEvent { /** @@ -13538,7 +14923,8 @@ declare interface CrownEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; @@ -13548,7 +14934,8 @@ declare interface CrownEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ angularVelocity: number; @@ -13558,7 +14945,8 @@ declare interface CrownEvent { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ degree: number; @@ -13568,7 +14956,8 @@ declare interface CrownEvent { * @type { CrownAction } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ action: CrownAction; @@ -13578,7 +14967,8 @@ declare interface CrownEvent { * @type { Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stopPropagation: Callback; } @@ -13598,7 +14988,8 @@ declare interface CrownEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BindOptions { /** @@ -13616,7 +15007,8 @@ declare interface BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -13635,7 +15027,8 @@ declare interface BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAppear?: () => void; @@ -13654,7 +15047,8 @@ declare interface BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onDisappear?: () => void; @@ -13665,7 +15059,8 @@ declare interface BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: () => void; @@ -13676,7 +15071,8 @@ declare interface BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: () => void; } @@ -13714,6 +15110,42 @@ declare interface DismissContentCoverAction { reason: DismissReason; } +/** + * Component content cover dismiss + * + * @interface DismissContentCoverAction + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @arkts 1.2 + * @since 20 + */ +declare interface DismissContentCoverAction { + /** + * Defines content cover dismiss function + * + * @type { VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @arkts 1.2 + * @since 20 + */ + dismiss: VoidCallback; + + /** + * Defines content cover dismiss reason + * + * @type { DismissReason } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @arkts 1.2 + * @since 20 + */ + reason: DismissReason; +} + /** * Component content cover options * @@ -13731,7 +15163,8 @@ declare interface DismissContentCoverAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ContentCoverOptions extends BindOptions { /** @@ -13751,7 +15184,8 @@ declare interface ContentCoverOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ modalTransition?: ModalTransition, @@ -13762,7 +15196,8 @@ declare interface ContentCoverOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: Callback; @@ -13773,7 +15208,8 @@ declare interface ContentCoverOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; } @@ -13793,7 +15229,8 @@ declare interface ContentCoverOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SheetTitleOptions { /** @@ -13811,7 +15248,8 @@ declare interface SheetTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ title: ResourceStr; @@ -13830,7 +15268,8 @@ declare interface SheetTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ subtitle?: ResourceStr; } @@ -13850,7 +15289,8 @@ declare interface SheetTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SheetType { /** @@ -13866,8 +15306,9 @@ declare enum SheetType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ BOTTOM = 0, /** @@ -13883,7 +15324,8 @@ declare enum SheetType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 1, @@ -13900,7 +15342,8 @@ declare enum SheetType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ POPUP = 2, } @@ -13912,7 +15355,8 @@ declare enum SheetType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SheetMode { /** @@ -13921,7 +15365,8 @@ declare enum SheetMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OVERLAY = 0, @@ -13931,7 +15376,8 @@ declare enum SheetMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED = 1, } @@ -13943,7 +15389,8 @@ declare enum SheetMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollSizeMode { /** @@ -13952,7 +15399,8 @@ declare enum ScrollSizeMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLLOW_DETENT = 0, @@ -13962,7 +15410,8 @@ declare enum ScrollSizeMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUOUS = 1, } @@ -13974,7 +15423,8 @@ declare enum ScrollSizeMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SheetKeyboardAvoidMode { /** @@ -13983,7 +15433,8 @@ declare enum SheetKeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -13994,7 +15445,8 @@ declare enum SheetKeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TRANSLATE_AND_RESIZE = 1, @@ -14004,7 +15456,8 @@ declare enum SheetKeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_ONLY = 2, @@ -14015,7 +15468,8 @@ declare enum SheetKeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TRANSLATE_AND_SCROLL = 3, } @@ -14058,6 +15512,30 @@ declare interface SheetDismiss { dismiss: () => void; } +/** + * Component sheet dismiss + * + * @interface SheetDismiss + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface SheetDismiss { + /** + * Defines sheet dismiss function + * + * @type { VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + dismiss: VoidCallback; +} + /** * Component sheet dismiss * @@ -14093,7 +15571,44 @@ declare interface DismissSheetAction { } /** - * Defines sheet spring back action + * Component sheet dismiss + * + * @interface DismissSheetAction + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface DismissSheetAction { + + /** + * Defines sheet dismiss function + * + * @type { VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + dismiss: VoidCallback; + + /** + * Dismiss reason type. + * + * @type { DismissReason } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + reason: DismissReason; +} + +/** + * Defines sheet spring back action * * @interface SpringBackAction * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -14111,7 +15626,31 @@ declare interface SpringBackAction { * @atomicservice * @since 12 */ - springBack: Callback; + springBack: Callback; +} + +/** + * Defines sheet spring back action + * + * @interface SpringBackAction + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface SpringBackAction { + /** + * Defines spring back function + * + * @type { VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + springBack: VoidCallback; } /** @@ -14131,7 +15670,8 @@ declare interface SpringBackAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SheetOptions extends BindOptions { /** @@ -14151,7 +15691,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: SheetSize | Length; @@ -14172,13 +15713,14 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ dragBar?: boolean; /** * Defines sheet maskColor - * + * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -14186,12 +15728,13 @@ declare interface SheetOptions extends BindOptions { */ /** * Defines sheet maskColor - * + * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskColor?: ResourceColor; @@ -14214,9 +15757,21 @@ declare interface SheetOptions extends BindOptions { */ detents?: [(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?]; + /** + * Defines sheet detents + * + * @type { ?[(SheetSize | Length), (SheetSize | Length)?, (SheetSize | Length)?] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + detents?: [(SheetSize | Length), SheetSize | Length | undefined, SheetSize | Length | undefined]; + /** * Defines sheet background blur Style - * + * * @type { ?BlurStyle } * @default BlurStyle.NONE * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -14225,13 +15780,14 @@ declare interface SheetOptions extends BindOptions { */ /** * Defines sheet background blur Style - * + * * @type { ?BlurStyle } * @default BlurStyle.NONE * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ blurStyle?: BlurStyle; @@ -14252,7 +15808,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showClose?: boolean | Resource; @@ -14271,7 +15828,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preferType?: SheetType; @@ -14290,7 +15848,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ title?: SheetTitleOptions | CustomBuilder; @@ -14309,7 +15868,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shouldDismiss?: (sheetDismiss: SheetDismiss) => void; @@ -14320,7 +15880,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: Callback; @@ -14331,7 +15892,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillSpringBackWhenDismiss?: Callback; @@ -14352,7 +15914,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableOutsideInteractive?: boolean; @@ -14363,7 +15926,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -14374,7 +15938,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth?: Dimension | EdgeWidths | LocalizedEdgeWidths; @@ -14385,7 +15950,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor?: ResourceColor | EdgeColors | LocalizedEdgeColors; @@ -14396,7 +15962,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderStyle?: BorderStyle | EdgeStyles; @@ -14407,7 +15974,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -14418,7 +15986,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onHeightDidChange?: Callback; @@ -14430,7 +15999,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ mode?: SheetMode; @@ -14442,7 +16012,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scrollSizeMode?: ScrollSizeMode; @@ -14454,7 +16025,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDetentsDidChange?: Callback; @@ -14465,7 +16037,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWidthDidChange?: Callback; @@ -14476,7 +16049,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onTypeDidChange?: Callback; @@ -14487,7 +16061,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ uiContext?: UIContext; @@ -14499,7 +16074,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAvoidMode?: SheetKeyboardAvoidMode; @@ -14511,7 +16087,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -14523,7 +16100,8 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -14533,7 +16111,8 @@ declare interface SheetOptions extends BindOptions { * @type { ?Position } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Position @@ -14545,18 +16124,20 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ effectEdge?: number /** * Defines sheet radius - * + * * @type { ?(LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses) } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: LengthMetrics | BorderRadiuses | LocalizedBorderRadiuses; @@ -14568,19 +16149,21 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ detentSelection?: SheetSize | Length; /** - * Whether to display in the sub window + * Whether to display in the sub window * - * @type { ?boolean } + * @type { ?boolean } * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -14593,23 +16176,38 @@ declare interface SheetOptions extends BindOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ placement?: Placement; /** * placement On target node * - * @type { ?boolean } + * @type { ?boolean } * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ placementOnTarget?: boolean; } +/** + * The custom styles function block. + * + * @typedef { function } CustomStyles + * @param { CommonMethod } instance - The component instance which can be used to set common attributes. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type CustomStyles = (instance: CommonMethod) => void; + /** * Component State Styles. * @@ -14642,7 +16240,8 @@ declare interface SheetOptions extends BindOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface StateStyles { /** @@ -14681,6 +16280,20 @@ declare interface StateStyles { */ normal?: any; + + /** + * Defines normal state styles. + * + * @type { ?CustomStyles } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + normal?: CustomStyles; + /** * Defines pressed state styles. * @@ -14717,6 +16330,19 @@ declare interface StateStyles { */ pressed?: any; + /** + * Defines pressed state styles. + * + * @type { ?CustomStyles } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pressed?: CustomStyles; + /** * Defines disabled state styles. * @@ -14753,6 +16379,19 @@ declare interface StateStyles { */ disabled?: any; + /** + * Defines disabled state styles. + * + * @type { ?CustomStyles } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + disabled?: CustomStyles; + /** * Defines focused state styles. * @@ -14789,6 +16428,19 @@ declare interface StateStyles { */ focused?: any; + /** + * Defines focused state styles. + * + * @type { ?CustomStyles } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + focused?: CustomStyles; + /** * Defines clicked state styles. * @@ -14825,6 +16477,19 @@ declare interface StateStyles { */ clicked?: any; + /** + * Defines clicked state styles. + * + * @type { ?CustomStyles } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + clicked?: CustomStyles; + /** * Defines selected state styles. * @@ -14845,6 +16510,20 @@ declare interface StateStyles { * @since 11 */ selected?: object; + + /** + * Defines selected state styles. + * + * @type { ?CustomStyles } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + selected?: CustomStyles; + } /** @@ -14862,7 +16541,8 @@ declare interface StateStyles { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PopupMessageOptions { /** @@ -14880,7 +16560,8 @@ declare interface PopupMessageOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textColor?: ResourceColor; @@ -14899,7 +16580,8 @@ declare interface PopupMessageOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ font?: Font; } @@ -14911,16 +16593,18 @@ declare interface PopupMessageOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -declare enum DismissReason { +declare enum DismissReason { /** * Press back * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRESS_BACK = 0, @@ -14930,7 +16614,8 @@ declare enum DismissReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOUCH_OUTSIDE = 1, @@ -14940,7 +16625,8 @@ declare enum DismissReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CLOSE_BUTTON = 2, @@ -14950,7 +16636,8 @@ declare enum DismissReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SLIDE_DOWN = 3 } @@ -14962,7 +16649,8 @@ declare enum DismissReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DismissPopupAction { /** @@ -14972,7 +16660,8 @@ declare interface DismissPopupAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dismiss: Callback; @@ -14983,7 +16672,8 @@ declare interface DismissPopupAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reason: DismissReason; } @@ -14995,17 +16685,20 @@ declare interface DismissPopupAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PopupStateChangeParam { /** * is Visible. + * Anonymous Object Rectification. * * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ isVisible: boolean; } @@ -15018,7 +16711,8 @@ declare interface PopupStateChangeParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type PopupStateChangeCallback = (event: PopupStateChangeParam) => void; @@ -15029,7 +16723,8 @@ declare type PopupStateChangeCallback = (event: PopupStateChangeParam) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PopupMaskType { /** @@ -15039,7 +16734,8 @@ declare interface PopupMaskType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ color: ResourceColor; } @@ -15051,7 +16747,8 @@ declare interface PopupMaskType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PopupCommonOptions { /** @@ -15062,7 +16759,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ placement?: Placement; @@ -15073,7 +16771,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ popupColor?: ResourceColor; @@ -15085,7 +16784,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableArrow?: boolean; @@ -15097,18 +16797,20 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ autoCancel?: boolean; /** * on State Change * - * @type { ?function } + * @type { ?PopupStateChangeCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onStateChange?: PopupStateChangeCallback; @@ -15119,7 +16821,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowOffset?: Length; @@ -15130,7 +16833,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -15143,7 +16847,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ mask?: boolean | PopupMaskType; @@ -15154,7 +16859,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ targetSpace?: Length; @@ -15165,7 +16871,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Position; @@ -15176,7 +16883,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -15187,7 +16895,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowPointPosition?: ArrowPointPosition; @@ -15199,7 +16908,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowWidth?: Dimension; @@ -15211,7 +16921,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowHeight?: Dimension; @@ -15223,7 +16934,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: Dimension; @@ -15235,7 +16947,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -15247,7 +16960,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -15259,7 +16973,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ focusable?: boolean; @@ -15270,7 +16985,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -15282,7 +16998,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: boolean | Callback; @@ -15294,7 +17011,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -15306,7 +17024,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ followTransformOfTarget?: boolean; } @@ -15318,7 +17037,8 @@ declare interface PopupCommonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TipsOptions { @@ -15329,7 +17049,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ appearingTime?: number; @@ -15340,7 +17061,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ disappearingTime?: number; @@ -15351,7 +17073,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ appearingTimeWithContinuousOperation?: number; @@ -15362,7 +17085,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ disappearingTimeWithContinuousOperation?: number; @@ -15374,7 +17098,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableArrow?: boolean; @@ -15385,7 +17110,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowPointPosition?: ArrowPointPosition; @@ -15397,7 +17123,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowWidth?: Dimension; @@ -15409,11 +17136,49 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowHeight?: Dimension; } +/** + * Defines the popup button. + * + * @interface PopupButton + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface PopupButton { + + /** + * Button text value + * + * @type { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + value: string; + + /** + * action + * + * @type { Callback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + action: Callback; +} + /** * Defines the popup options. * @@ -15436,7 +17201,8 @@ declare interface TipsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PopupOptions { /** @@ -15461,7 +17227,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ message: string; @@ -15495,7 +17262,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placement?: Placement; @@ -15577,6 +17345,17 @@ declare interface PopupOptions { action: () => void; }; + /** + * The first button. + * + * @type { ?PopupButton } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + primaryButton?: PopupButton; /** * The second button. * @@ -15655,6 +17434,18 @@ declare interface PopupOptions { action: () => void; }; + /** + * The second button. + * + * @type { ?PopupButton } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + secondaryButton?:PopupButton + /** * on State Change * @@ -15700,6 +17491,18 @@ declare interface PopupOptions { isVisible: boolean }) => void; + /** + * on State Change + * + * @type { ?PopupStateChangeCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onStateChange?: PopupStateChangeCallback; + /** * The offset of the sharp corner of popup. * @@ -15722,7 +17525,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrowOffset?: Length; @@ -15748,7 +17552,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -15775,6 +17580,20 @@ declare interface PopupOptions { */ mask?: boolean | { color: ResourceColor }; + /** + * The mask to block gesture events of popup. + * When mask is set false, gesture events are not blocked. + * When mask is set true, gesture events are blocked and mask color is transparent. + * + * @type { ?(boolean | PopupMaskType) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + mask?: boolean | PopupMaskType; + /** * Sets the options of popup message. * @@ -15790,7 +17609,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ messageOptions?: PopupMessageOptions @@ -15809,7 +17629,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ targetSpace?: Length @@ -15829,7 +17650,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableArrow?: boolean; /** @@ -15847,7 +17669,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Position @@ -15866,7 +17689,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ popupColor?: Color | string | Resource | number; @@ -15887,7 +17711,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ autoCancel?: boolean; @@ -15906,7 +17731,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -15925,7 +17751,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ arrowPointPosition?: ArrowPointPosition; @@ -15946,7 +17773,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ arrowWidth?: Dimension; @@ -15967,7 +17795,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ arrowHeight?: Dimension; @@ -15988,7 +17817,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: Dimension; @@ -16009,7 +17839,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -16030,7 +17861,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -16041,7 +17873,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -16052,10 +17885,11 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: boolean | Callback; - + /** * Determine if it is compatible popup's half folded. * @@ -16064,7 +17898,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -16076,7 +17911,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ followTransformOfTarget?: boolean; @@ -16088,7 +17924,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAvoidMode?: KeyboardAvoidMode; } @@ -16115,7 +17952,8 @@ declare interface PopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CustomPopupOptions { /** @@ -16140,7 +17978,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ builder: CustomBuilder; @@ -16166,7 +18005,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placement?: Placement; @@ -16203,7 +18043,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ popupColor?: Color | string | Resource | number; @@ -16229,7 +18070,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableArrow?: boolean; @@ -16255,7 +18097,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ autoCancel?: boolean; @@ -16304,6 +18147,18 @@ declare interface CustomPopupOptions { isVisible: boolean }) => void; + /** + * on State Change + * + * @type { ?PopupStateChangeCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onStateChange?: PopupStateChangeCallback; + /** * The offset of the sharp corner of popup. * @@ -16326,7 +18181,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrowOffset?: Length; @@ -16352,7 +18208,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -16379,6 +18236,20 @@ declare interface CustomPopupOptions { */ mask?: boolean | { color: ResourceColor }; + /** + * The mask to block gesture events of popup. + * When mask is set false, gesture events are not blocked. + * When mask is set true, gesture events are blocked and mask color is transparent. + * + * @type { ?(boolean | PopupMaskType) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + mask?: boolean | PopupMaskType; + /** * Sets the space of between the popup and target. * @@ -16394,7 +18265,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ targetSpace?: Length @@ -16413,7 +18285,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Position @@ -16432,7 +18305,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -16451,7 +18325,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ arrowPointPosition?: ArrowPointPosition; @@ -16472,7 +18347,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ arrowWidth?: Dimension; @@ -16493,7 +18369,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ arrowHeight?: Dimension; @@ -16514,7 +18391,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: Dimension; @@ -16535,7 +18413,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -16556,7 +18435,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -16577,7 +18457,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ focusable?: boolean; @@ -16588,7 +18469,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -16599,7 +18481,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: boolean | Callback; @@ -16611,7 +18494,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -16623,7 +18507,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ followTransformOfTarget?: boolean; @@ -16635,7 +18520,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAvoidMode?: KeyboardAvoidMode; } @@ -16655,7 +18541,8 @@ declare interface CustomPopupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MenuPreviewMode { /** @@ -16671,8 +18558,9 @@ declare enum MenuPreviewMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ NONE = 0, /** * Defines image type preview content. @@ -16687,7 +18575,8 @@ declare enum MenuPreviewMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1 } @@ -16711,6 +18600,18 @@ declare enum MenuPreviewMode { */ declare type AnimationRange = [from: T, to: T]; +/** + * Defines the animator range of start and end property. + * + * @typedef { [number, number] } AnimationNumberRange + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type AnimationNumberRange = [number, number]; + /** * Defines the ContextMenu's preview animator options. * @@ -16726,7 +18627,8 @@ declare type AnimationRange = [from: T, to: T]; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ContextMenuAnimationOptions { /** @@ -16749,6 +18651,19 @@ interface ContextMenuAnimationOptions { * @since 12 */ scale?: AnimationRange; + + /** + * Sets the start animator scale and end animator scale. + * + * @type { ?AnimationNumberRange } + * @default - + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scale?: AnimationNumberRange; /** * Defines the transition effect of menu preview opening and closing. * @@ -16756,7 +18671,8 @@ interface ContextMenuAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -16770,6 +18686,18 @@ interface ContextMenuAnimationOptions { * @since 12 */ hoverScale?: AnimationRange; + + /** + * Sets the scale start and end animator of the image displayed before the custom builder preview is displayed. + * + * @type { ?AnimationNumberRange } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + hoverScale?: AnimationNumberRange; } /** @@ -16779,7 +18707,8 @@ interface ContextMenuAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ type BorderRadiusType = Length | BorderRadiuses | LocalizedBorderRadiuses; @@ -16790,7 +18719,8 @@ type BorderRadiusType = Length | BorderRadiuses | LocalizedBorderRadiuses; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HapticFeedbackMode { /** @@ -16799,8 +18729,9 @@ declare enum HapticFeedbackMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 - */ + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ DISABLED = 0, /** * Defines menu always haptic feedback. @@ -16808,7 +18739,8 @@ declare enum HapticFeedbackMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENABLED = 1, /** @@ -16817,7 +18749,8 @@ declare enum HapticFeedbackMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 2 } @@ -16837,7 +18770,8 @@ declare enum HapticFeedbackMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ContextMenuOptions { /** @@ -16857,7 +18791,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Position; @@ -16878,7 +18813,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placement?: Placement; @@ -16898,7 +18834,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableArrow?: boolean; @@ -16918,13 +18855,14 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrowOffset?: Length; - + /** * The preview content of context menu. - * + * * @type { ?(MenuPreviewMode | CustomBuilder) } * @default MenuPreviewMode.NONE * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -16933,13 +18871,14 @@ declare interface ContextMenuOptions { */ /** * The preview content of context menu. - * + * * @type { ?(MenuPreviewMode | CustomBuilder) } * @default MenuPreviewMode.NONE * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preview?: MenuPreviewMode | CustomBuilder; @@ -16950,7 +18889,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ previewBorderRadius?: BorderRadiusType; @@ -16961,7 +18901,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius?: Length | BorderRadiuses | LocalizedBorderRadiuses; @@ -16980,7 +18921,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAppear?: () => void; @@ -16999,7 +18941,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onDisappear?: () => void; @@ -17018,7 +18961,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ aboutToAppear?: () => void; @@ -17037,10 +18981,11 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ aboutToDisappear?: () => void; - + /** * The margin of menu's layoutRegion. * @@ -17048,10 +18993,11 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ layoutRegionMargin?: Margin; - + /** * The preview animator options. * @@ -17067,7 +19013,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ previewAnimationOptions?: ContextMenuAnimationOptions; @@ -17088,7 +19035,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -17109,7 +19057,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -17120,7 +19069,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -17131,7 +19081,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -17142,7 +19093,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition?: TransitionEffect; @@ -17154,7 +19106,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -17165,7 +19118,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outlineColor?: ResourceColor | EdgeColors; @@ -17176,7 +19130,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outlineWidth?: Dimension | EdgeOutlineWidths; @@ -17188,7 +19143,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ hapticFeedbackMode?: HapticFeedbackMode; } @@ -17210,7 +19166,8 @@ declare interface ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MenuOptions extends ContextMenuOptions { /** @@ -17228,7 +19185,8 @@ declare interface MenuOptions extends ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title?: ResourceStr; @@ -17247,7 +19205,8 @@ declare interface MenuOptions extends ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; } @@ -17265,7 +19224,8 @@ declare interface MenuOptions extends ContextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ProgressMask { /** @@ -17287,7 +19247,8 @@ declare class ProgressMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: number, total: number, color: ResourceColor); @@ -17306,7 +19267,8 @@ declare class ProgressMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ updateProgress(value: number): void; @@ -17325,10 +19287,11 @@ declare class ProgressMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ updateColor(value: ResourceColor): void; - + /** * Enable the breathe animation of mask. * @@ -17336,7 +19299,8 @@ declare class ProgressMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableBreathingAnimation(value: boolean): void; } @@ -17354,7 +19318,8 @@ declare class ProgressMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TouchTestInfo { /** @@ -17372,7 +19337,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -17391,7 +19357,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -17410,7 +19377,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ parentX: number; @@ -17429,7 +19397,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ parentY: number; @@ -17448,7 +19417,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -17467,7 +19437,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -17486,7 +19457,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rect: RectResult; @@ -17505,7 +19477,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: string; } @@ -17523,7 +19496,8 @@ declare class TouchTestInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TouchResult { /** @@ -17541,7 +19515,8 @@ declare class TouchResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strategy: TouchTestStrategy; @@ -17560,7 +19535,8 @@ declare class TouchResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id?: string; } @@ -17582,7 +19558,8 @@ declare class TouchResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PixelStretchEffectOptions { /** @@ -17604,7 +19581,8 @@ declare interface PixelStretchEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: Length; @@ -17627,7 +19605,8 @@ declare interface PixelStretchEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: Length; @@ -17650,7 +19629,8 @@ declare interface PixelStretchEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: Length; @@ -17673,7 +19653,8 @@ declare interface PixelStretchEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ right?: Length; } @@ -17693,7 +19674,8 @@ declare interface PixelStretchEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ClickEffect { /** @@ -17711,7 +19693,8 @@ declare interface ClickEffect { * @default ClickEffectLevel.Light * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ level: ClickEffectLevel; @@ -17730,7 +19713,8 @@ declare interface ClickEffect { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scale?: number; } @@ -17742,7 +19726,8 @@ declare interface ClickEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FadingEdgeOptions { /** @@ -17753,7 +19738,8 @@ declare interface FadingEdgeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ fadingEdgeLength?: LengthMetrics; } @@ -17771,7 +19757,8 @@ declare interface FadingEdgeOptions { * @interface NestedScrollOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NestedScrollOptions { /** @@ -17788,7 +19775,8 @@ declare interface NestedScrollOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollForward: NestedScrollMode; @@ -17806,7 +19794,8 @@ declare interface NestedScrollOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBackward: NestedScrollMode; } @@ -17833,7 +19822,8 @@ declare interface NestedScrollOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MenuElement { /** @@ -17858,7 +19848,8 @@ declare interface MenuElement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: ResourceStr; @@ -17877,7 +19868,8 @@ declare interface MenuElement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: ResourceStr; @@ -17887,7 +19879,8 @@ declare interface MenuElement { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolIcon?: SymbolGlyphModifier; @@ -17910,7 +19903,8 @@ declare interface MenuElement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enabled?: boolean; @@ -17936,14 +19930,15 @@ declare interface MenuElement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ action: () => void; } /** * Defines the attribute modifier. - * + * * @interface AttributeModifier * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -17951,7 +19946,7 @@ declare interface MenuElement { */ /** * Defines the attribute modifier. - * + * * @interface AttributeModifier * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -17962,7 +19957,7 @@ declare interface AttributeModifier { /** * Defines the normal update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -17970,7 +19965,7 @@ declare interface AttributeModifier { */ /** * Defines the normal update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -17981,7 +19976,7 @@ declare interface AttributeModifier { /** * Defines the pressed update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -17989,7 +19984,7 @@ declare interface AttributeModifier { */ /** * Defines the pressed update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18000,7 +19995,7 @@ declare interface AttributeModifier { /** * Defines the focused update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18008,7 +20003,7 @@ declare interface AttributeModifier { */ /** * Defines the focused update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18019,7 +20014,7 @@ declare interface AttributeModifier { /** * Defines the disabled update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18027,7 +20022,7 @@ declare interface AttributeModifier { */ /** * Defines the disabled update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18038,7 +20033,7 @@ declare interface AttributeModifier { /** * Defines the selected update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18046,7 +20041,7 @@ declare interface AttributeModifier { */ /** * Defines the selected update attribute function. - * + * * @param { T } instance * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18056,20 +20051,93 @@ declare interface AttributeModifier { applySelectedAttribute?(instance: T) : void; } + +/** + * Defines the attribute modifier. + * + * @interface AttributeModifier + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface AttributeModifier { + + + /** + * Defines the normal update attribute function. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyNormalAttribute?:(instance: T) => void; + + + /** + * Defines the pressed update attribute function. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyPressedAttribute?:(instance: T) => void; + + /** + * Defines the focused update attribute function. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyFocusedAttribute?:(instance: T) => void; + + + /** + * Defines the disabled update attribute function. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyDisabledAttribute?:(instance: T) => void; + + + /** + * Defines the selected update attribute function. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applySelectedAttribute?:(instance: T) => void; +} /** * Defines the content modifier. - * + * * @interface ContentModifier * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ContentModifier { /** * Defining applyContent function. - * + * * @returns { WrappedBuilder<[T]> } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18077,19 +20145,32 @@ declare interface ContentModifier { * @since 12 */ applyContent(): WrappedBuilder<[T]> + + /** + * Defining applyContent function. + * + * @returns { WrappedBuilder<[T]> } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + applyContent(): WrappedBuilder> } /** * Defines the common configuration. - * + * * @interface CommonConfiguration * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CommonConfiguration { - + /** * If the value is true, the contentModifier is available and can respond to operations such as triggerChange. * If it is set to false, triggerChange operations are not responded. @@ -18098,18 +20179,20 @@ declare interface CommonConfiguration { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enabled: boolean, /** * Obtains the contentModifier instance object - * + * * @type { ContentModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier: ContentModifier } @@ -18131,7 +20214,8 @@ declare interface CommonConfiguration { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum OutlineStyle { /** @@ -18149,7 +20233,8 @@ declare enum OutlineStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOLID = 0, @@ -18168,7 +20253,8 @@ declare enum OutlineStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DASHED = 1, @@ -18187,7 +20273,8 @@ declare enum OutlineStyle { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOTTED = 2, } @@ -18214,7 +20301,8 @@ declare enum OutlineStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DragPreviewMode { /** @@ -18236,7 +20324,8 @@ declare enum DragPreviewMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 1, /** @@ -18258,7 +20347,8 @@ declare enum DragPreviewMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DISABLE_SCALE = 2, /** @@ -18274,7 +20364,8 @@ declare enum DragPreviewMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENABLE_DEFAULT_SHADOW = 3, /** @@ -18290,7 +20381,8 @@ declare enum DragPreviewMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENABLE_DEFAULT_RADIUS = 4, /** @@ -18298,7 +20390,8 @@ declare enum DragPreviewMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENABLE_DRAG_ITEM_GRAY_EFFECT = 5, /** @@ -18306,7 +20399,8 @@ declare enum DragPreviewMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENABLE_MULTI_TILE_EFFECT = 6, /** @@ -18314,7 +20408,8 @@ declare enum DragPreviewMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENABLE_TOUCH_POINT_CALCULATION_BASED_ON_FINAL_PREVIEW = 7, } @@ -18325,7 +20420,8 @@ declare enum DragPreviewMode { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DraggingSizeChangeEffect { /** @@ -18333,7 +20429,8 @@ declare enum DraggingSizeChangeEffect { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -18342,7 +20439,8 @@ declare enum DraggingSizeChangeEffect { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SIZE_TRANSITION = 1, @@ -18351,7 +20449,8 @@ declare enum DraggingSizeChangeEffect { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SIZE_CONTENT_TRANSITION = 2, } @@ -18363,7 +20462,8 @@ declare enum DraggingSizeChangeEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MenuPolicy { /** @@ -18372,7 +20472,8 @@ declare enum MenuPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -18382,7 +20483,8 @@ declare enum MenuPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIDE = 1, @@ -18392,7 +20494,8 @@ declare enum MenuPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHOW = 2, } @@ -18440,7 +20543,8 @@ declare type SymbolGlyphModifier = import('../api/arkui/SymbolGlyphModifier').Sy * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DragPreviewOptions { /** @@ -18465,7 +20569,8 @@ declare interface DragPreviewOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ mode?: DragPreviewMode | Array; @@ -18503,7 +20608,8 @@ declare interface DragPreviewOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ numberBadge?: boolean | number; @@ -18513,7 +20619,8 @@ declare interface DragPreviewOptions { * @type { ?DraggingSizeChangeEffect } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sizeChangeEffect?: DraggingSizeChangeEffect; } @@ -18524,7 +20631,8 @@ declare interface DragPreviewOptions { * @interface DragInteractionOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DragInteractionOptions { /** @@ -18533,17 +20641,19 @@ declare interface DragInteractionOptions { * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isMultiSelectionEnabled?: boolean; - + /** * Define whether to execute animation before preview floating. * * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ defaultAnimationBeforeLifting?: boolean; @@ -18553,7 +20663,8 @@ declare interface DragInteractionOptions { * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableEdgeAutoScroll?: boolean; @@ -18563,7 +20674,8 @@ declare interface DragInteractionOptions { * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback?: boolean; @@ -18574,7 +20686,8 @@ declare interface DragInteractionOptions { * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ isLiftingDisabled?: boolean; } @@ -18585,7 +20698,8 @@ declare interface DragInteractionOptions { * @interface PreviewConfiguration * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PreviewConfiguration { /** @@ -18595,7 +20709,8 @@ declare interface PreviewConfiguration { * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onlyForLifting?: boolean; @@ -18606,7 +20721,8 @@ declare interface PreviewConfiguration { * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ delayCreating?: boolean; } @@ -18624,13 +20740,14 @@ declare interface PreviewConfiguration { * @interface InvertOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface InvertOptions { /** * Defines the low value of threshold - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18638,18 +20755,19 @@ declare interface InvertOptions { */ /** * Defines the low value of threshold - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ low: number; /** * Defines the high value of threshold - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18657,18 +20775,19 @@ declare interface InvertOptions { */ /** * Defines the high value of threshold - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ high: number; /** * Defines the threshold - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18676,18 +20795,19 @@ declare interface InvertOptions { */ /** * Defines the threshold - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ threshold: number; - + /** *Defines the threshold range - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18695,19 +20815,20 @@ declare interface InvertOptions { */ /** *Defines the threshold range - * + * * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ thresholdRange: number; } /** * Import the CircleShape type object for common method. - * + * * @typedef { import('../api/@ohos.arkui.shape').CircleShape } CircleShape * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18719,7 +20840,7 @@ declare type CircleShape = import('../api/@ohos.arkui.shape').CircleShape; /** * Import the EllipseShape type object for common method. - * + * * @typedef { import('../api/@ohos.arkui.shape').EllipseShape } EllipseShape * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18731,7 +20852,7 @@ declare type EllipseShape = import('../api/@ohos.arkui.shape').EllipseShape; /** * Import the PathShape type object for common method. - * + * * @typedef { import('../api/@ohos.arkui.shape').PathShape } PathShape * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18743,7 +20864,7 @@ declare type PathShape = import('../api/@ohos.arkui.shape').PathShape; /** * Import the RectShape type object for common method. - * + * * @typedef { import('../api/@ohos.arkui.shape').RectShape } RectShape * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -18761,7 +20882,8 @@ declare type RectShape = import('../api/@ohos.arkui.shape').RectShape; * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type Optional = T | undefined; @@ -18772,7 +20894,8 @@ declare type Optional = T | undefined; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type TipsMessageType = ResourceStr | StyledString; @@ -18784,7 +20907,8 @@ declare type TipsMessageType = ResourceStr | StyledString; * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface BackgroundImageOptions { /** @@ -18797,7 +20921,8 @@ interface BackgroundImageOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ syncLoad?: boolean; /** @@ -18809,11 +20934,36 @@ interface BackgroundImageOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ repeat?: ImageRepeat; } +/** + * Define the options of background + * + * @interface BackgroundOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface BackgroundOptions { + /** + *Defines the align + * + * @type { ?Alignment } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + align?: Alignment +} + /** * CommonMethod. * @@ -18842,7 +20992,8 @@ interface BackgroundImageOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CommonMethod { /** @@ -18858,7 +21009,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -18898,7 +21050,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width(value: Length): T; /** @@ -18910,7 +21063,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ width(widthValue: Length | LayoutPolicy): T; @@ -18950,7 +21104,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height(value: Length): T; /** @@ -18962,10 +21117,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ height(heightValue: Length | LayoutPolicy): T; - + /** * Sets the drawModifier of the current component. * @@ -18974,7 +21130,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ drawModifier(modifier: DrawModifier | undefined): T; @@ -18987,7 +21144,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customProperty(name: string, value: Optional): T; @@ -19010,7 +21168,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ expandSafeArea(types?: Array, edges?: Array): T; @@ -19050,7 +21209,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ responseRegion(value: Array | Rectangle): T; @@ -19071,7 +21231,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mouseResponseRegion(value: Array | Rectangle): T; @@ -19111,7 +21272,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size(value: SizeOptions): T; @@ -19155,7 +21317,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constraintSize(value: ConstraintSizeOptions): T; @@ -19196,7 +21359,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hitTestBehavior(value: HitTestMode): T; @@ -19217,7 +21381,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onChildTouchTest(event: (value: Array) => TouchResult): T; @@ -19257,7 +21422,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ layoutWeight(value: number | string): T; @@ -19269,7 +21435,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ chainWeight(chainWeight: ChainWeightOptions): T; @@ -19320,7 +21487,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ padding(value: Padding | Length | LocalizedPadding): T; @@ -19333,10 +21501,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ safeAreaPadding(paddingValue: Padding | LengthMetrics | LocalizedPadding): T; - + /** * Outer Margin. * @@ -19384,7 +21553,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ margin(value: Margin | Length | LocalizedMargin): T; @@ -19411,6 +21581,19 @@ declare class CommonMethod { */ background(builder: CustomBuilder, options?: { align?: Alignment }): T; + /** + * Background. + * + * @param { CustomBuilder } builder + * @param { BackgroundOptions } options + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + background(builder: CustomBuilder, options?: BackgroundOptions): T; /** * Background color * @@ -19447,7 +21630,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor(value: ResourceColor): T; @@ -19460,7 +21644,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor(color: Optional): T; @@ -19473,7 +21658,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pixelRound(value: PixelRoundPolicy): T; @@ -19534,7 +21720,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundImage(src: ResourceStr | PixelMap, repeat?: ImageRepeat): T; @@ -19548,10 +21735,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundImage(src: ResourceStr | PixelMap, options?: BackgroundImageOptions): T; - + /** * Background image size * @@ -19588,7 +21776,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundImageSize(value: SizeOptions | ImageSize): T; @@ -19632,7 +21821,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundImagePosition(value: Position | Alignment): T; @@ -19670,7 +21860,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle(value: BlurStyle, options?: BackgroundBlurStyleOptions): T; @@ -19687,7 +21878,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle(style: Optional, options?: BackgroundBlurStyleOptions, sysOptions?: SystemAdaptiveOptions): T; @@ -19708,7 +21900,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect(options: BackgroundEffectOptions): T; @@ -19722,7 +21915,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect(options: Optional, sysOptions?: SystemAdaptiveOptions): T; @@ -19735,7 +21929,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundImageResizable(value: ResizableOptions): T; @@ -19747,7 +21942,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ foregroundEffect(options: ForegroundEffectOptions): T; @@ -19759,7 +21955,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ visualEffect(effect: VisualEffect): T; @@ -19771,7 +21968,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundFilter(filter: Filter): T; @@ -19783,7 +21981,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ foregroundFilter(filter: Filter): T; @@ -19795,7 +21994,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compositingFilter(filter: Filter): T; @@ -19820,7 +22020,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ foregroundBlurStyle(value: BlurStyle, options?: ForegroundBlurStyleOptions): T; @@ -19836,7 +22037,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ foregroundBlurStyle(style: Optional, options?: ForegroundBlurStyleOptions, sysOptions?: SystemAdaptiveOptions): T; @@ -19876,7 +22078,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ opacity(value: number | Resource): T; @@ -19889,7 +22092,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ opacity(opacity: Optional): T; @@ -19933,7 +22137,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ border(value: BorderOptions): T; @@ -19973,7 +22178,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderStyle(value: BorderStyle | EdgeStyles): T; @@ -20024,7 +22230,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth(value: Length | EdgeWidths | LocalizedEdgeWidths): T; @@ -20075,7 +22282,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; @@ -20126,7 +22334,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius(value: Length | BorderRadiuses | LocalizedBorderRadiuses): T; @@ -20158,7 +22367,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderImage(value: BorderImageOption): T; @@ -20183,7 +22393,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ outline(value: OutlineOptions): T; @@ -20197,7 +22408,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outline(options: Optional): T; @@ -20221,7 +22433,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ outlineStyle(value: OutlineStyle | EdgeOutlineStyles): T; @@ -20234,7 +22447,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outlineStyle(style: Optional): T; @@ -20258,7 +22472,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ outlineWidth(value: Dimension | EdgeOutlineWidths): T; @@ -20271,7 +22486,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outlineWidth(width: Optional): T; @@ -20295,7 +22511,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ outlineColor(value: ResourceColor | EdgeColors | LocalizedEdgeColors): T; @@ -20308,7 +22525,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outlineColor(color: Optional): T; @@ -20332,7 +22550,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ outlineRadius(value: Dimension | OutlineRadiuses): T; @@ -20345,7 +22564,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ outlineRadius(radius: Optional): T; @@ -20368,7 +22588,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ foregroundColor(value: ResourceColor | ColoringStrategy): T; @@ -20381,7 +22602,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ foregroundColor(color: Optional): T; @@ -20421,12 +22643,13 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onClick(event: (event: ClickEvent) => void): T; /** - * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. + * Trigger a click event when a click is clicked, move distance should smaller than distanceThreshold. * * @param { function } event - this function callback executed when the click action is recognized * @param { number } distanceThreshold - the distance threshold of finger's movement when detecting a click action @@ -20435,7 +22658,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onClick(event: Callback, distanceThreshold: number): T; @@ -20455,7 +22679,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onHover(event: (isHover: boolean, event: HoverEvent) => void): T; @@ -20467,7 +22692,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onHoverMove(event: Callback): T; @@ -20479,7 +22705,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onAccessibilityHover(callback: AccessibilityCallback): T; @@ -20508,7 +22735,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hoverEffect(value: HoverEffect): T; @@ -20527,7 +22755,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onMouse(event: (event: MouseEvent) => void): T; @@ -20556,7 +22785,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onTouch(event: (event: TouchEvent) => void): T; @@ -20585,7 +22815,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onKeyEvent(event: (event: KeyEvent) => void): T; @@ -20597,7 +22828,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onKeyEvent(event: Callback): T; @@ -20608,7 +22840,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDigitalCrown(handler: Optional>): T; @@ -20620,7 +22853,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onKeyPreIme(event: Callback): T; @@ -20632,7 +22866,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onKeyEventDispatch(event: Callback): T; @@ -20643,7 +22878,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onFocusAxisEvent(event: Callback): T; @@ -20654,7 +22890,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAxisEvent(event: Callback): T; @@ -20683,7 +22920,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ focusable(value: boolean): T; @@ -20695,7 +22933,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ nextFocus(nextStep: Optional): T; @@ -20707,10 +22946,11 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ tabStop(isTabStop: boolean): T; - + /** * Trigger a event when got focus. * @@ -20736,7 +22976,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onFocus(event: () => void): T; @@ -20765,7 +23006,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onBlur(event: () => void): T; @@ -20794,7 +23036,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ tabIndex(index: number): T; @@ -20823,7 +23066,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ defaultFocus(value: boolean): T; @@ -20852,7 +23096,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ groupDefaultFocus(value: boolean): T; @@ -20881,7 +23126,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ focusOnTouch(value: boolean): T; @@ -20893,7 +23139,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ focusBox(style: FocusBoxStyle): T; @@ -20906,7 +23153,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ focusScopeId(id: string, isGroup?: boolean): T; /** @@ -20920,7 +23168,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ focusScopeId(id: string, isGroup?: boolean, arrowStepOut?: boolean): T; @@ -20933,7 +23182,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ focusScopePriority(scopeId: string, priority?: FocusPriority): T; @@ -20973,7 +23223,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ animation(value: AnimateParam): T; @@ -21017,6 +23268,20 @@ declare class CommonMethod { */ transition(value: TransitionOptions | TransitionEffect): T; + /** + * Set the transition effect of component when it appears and disappears. + * + * @param { TransitionEffect } value - transition effect + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + transition(value: TransitionEffect): T; + /** * Set the transition effect of component when it appears and disappears. * @@ -21027,7 +23292,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition(effect: TransitionEffect, onFinish: Optional): T; @@ -21062,7 +23328,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ gesture(gesture: GestureType, mask?: GestureMask): T; @@ -21097,7 +23364,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ priorityGesture(gesture: GestureType, mask?: GestureMask): T; @@ -21132,7 +23400,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ parallelGesture(gesture: GestureType, mask?: GestureMask): T; @@ -21181,7 +23450,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blur(value: number, options?: BlurOptions): T; @@ -21198,7 +23468,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ blur(blurRadius: Optional, options?: BlurOptions, sysOptions?: SystemAdaptiveOptions): T; @@ -21211,7 +23482,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ linearGradientBlur(value: number, options: LinearGradientBlurOptions): T; @@ -21224,19 +23496,21 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ linearGradientBlur(blurRadius: Optional, options: Optional): T; /** * Component motion blur interface. - * + * * @param { MotionBlurOptions } value - the attributes of motion blur. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ motionBlur(value: MotionBlurOptions):T; @@ -21248,7 +23522,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ motionBlur(motionBlur: Optional):T; @@ -21296,7 +23571,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ brightness(value: number): T; @@ -21311,7 +23587,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ brightness(brightness: Optional): T; @@ -21355,7 +23632,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ contrast(value: number): T; @@ -21369,7 +23647,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ contrast(contrast: Optional): T; @@ -21417,7 +23696,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ grayscale(value: number): T; @@ -21432,7 +23712,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ grayscale(grayscale: Optional): T; @@ -21472,7 +23753,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ colorBlend(value: Color | string | Resource): T; @@ -21485,7 +23767,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ colorBlend(color: Optional): T; @@ -21537,7 +23820,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ saturate(value: number): T; @@ -21553,7 +23837,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ saturate(saturate: Optional): T; @@ -21597,7 +23882,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sepia(value: number): T; @@ -21611,7 +23897,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sepia(sepia: Optional): T; @@ -21655,7 +23942,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ invert(value: number | InvertOptions): T; @@ -21669,7 +23957,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ invert(options: Optional): T; @@ -21679,7 +23968,8 @@ declare class CommonMethod { * @returns { T } return the component attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ systemBarEffect(): T; @@ -21727,7 +24017,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hueRotate(value: number | string): T; @@ -21742,7 +24033,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ hueRotate(rotation: Optional): T; @@ -21765,7 +24057,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ useShadowBatching(value: boolean): T; @@ -21778,7 +24071,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ useShadowBatching(use: Optional): T; @@ -21792,7 +24086,8 @@ declare class CommonMethod { * @returns { T } return the component attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ useEffect(useEffect: boolean, effectType: EffectType): T; @@ -21806,7 +24101,8 @@ declare class CommonMethod { * @returns { T } return the component attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ useEffect(useEffect: Optional, effectType?: EffectType): T; @@ -21819,7 +24115,8 @@ declare class CommonMethod { * @returns { T } return the component attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ useEffect(value: boolean): T; @@ -21864,7 +24161,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backdropBlur(value: number, options?: BlurOptions): T; @@ -21880,7 +24178,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backdropBlur(radius: Optional, options?: BlurOptions, sysOptions?: SystemAdaptiveOptions): T; @@ -21912,7 +24211,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderGroup(value: boolean): T; @@ -21925,7 +24225,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ renderGroup(isGroup: Optional): T; @@ -21937,7 +24238,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ freeze(value: boolean): T; @@ -21949,7 +24251,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ freeze(freeze: Optional): T; @@ -21995,7 +24298,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ translate(value: TranslateOptions): T; @@ -22008,7 +24312,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ translate(translate: Optional): T; @@ -22048,7 +24353,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scale(value: ScaleOptions): T; @@ -22061,7 +24367,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ scale(options: Optional): T; @@ -22169,7 +24476,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotate(value: RotateOptions): T; @@ -22182,7 +24490,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ rotate(options: Optional): T; @@ -22211,7 +24520,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ transform(value: object): T; @@ -22223,7 +24533,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ transform(transform: Optional): T; @@ -22263,7 +24574,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAppear(event: () => void): T; @@ -22303,7 +24615,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onDisAppear(event: () => void): T; @@ -22319,6 +24632,19 @@ declare class CommonMethod { */ onAttach(callback: Callback): T; + /** + * This callback is triggered when a component mounts to view tree. + * + * @param { VoidCallback } callback + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onAttach(callback: VoidCallback): T; + /** * This callback is triggered when a component is detached from view tree. * @@ -22331,6 +24657,19 @@ declare class CommonMethod { */ onDetach(callback: Callback): T; + /** + * This callback is triggered when a component is detached from view tree. + * + * @param { VoidCallback } callback + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDetach(callback: VoidCallback): T; + /** * This callback is triggered when the size or position of this component change finished. * @@ -22356,7 +24695,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAreaChange(event: (oldValue: Area, newValue: Area) => void): T; @@ -22396,7 +24736,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ visibility(value: Visibility): T; @@ -22436,7 +24777,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ flexGrow(value: number): T; @@ -22476,7 +24818,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ flexShrink(value: number): T; @@ -22516,7 +24859,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ flexBasis(value: number | string): T; @@ -22556,7 +24900,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignSelf(value: ItemAlign): T; @@ -22596,7 +24941,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayPriority(value: number): T; @@ -22636,7 +24982,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ zIndex(value: number): T; @@ -22668,7 +25015,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sharedTransition(id: string, options?: sharedTransitionOptions): T; @@ -22708,7 +25056,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction(value: Direction): T; @@ -22748,7 +25097,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ align(value: Alignment): T; @@ -22799,7 +25149,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position(value: Position | Edges | LocalizedEdges): T; @@ -22850,7 +25201,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ markAnchor(value: Position | LocalizedPosition): T; @@ -22906,7 +25258,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset(value: Position | Edges | LocalizedEdges): T; @@ -22950,7 +25303,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enabled(value: boolean): T; @@ -22999,7 +25353,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignRules(value: AlignRuleOption): T; @@ -23012,7 +25367,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alignRules(alignRule: LocalizedAlignRuleOptions): T; @@ -23025,7 +25381,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ chainMode(direction: Axis, style: ChainStyle): T; @@ -23065,7 +25422,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ aspectRatio(value: number): T; @@ -23086,7 +25444,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clickEffect(value: ClickEffect | null): T; @@ -23098,7 +25457,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ clickEffect(effect: Optional): T; @@ -23130,7 +25490,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDragStart(event: (event: DragEvent, extraParams?: string) => CustomBuilder | DragItemInfo): T; @@ -23159,7 +25520,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDragEnter(event: (event: DragEvent, extraParams?: string) => void): T; @@ -23188,7 +25550,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDragMove(event: (event: DragEvent, extraParams?: string) => void): T; @@ -23217,7 +25580,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDragLeave(event: (event: DragEvent, extraParams?: string) => void): T; @@ -23249,7 +25613,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDrop(event: (event: DragEvent, extraParams?: string) => void): T; @@ -23263,7 +25628,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onDrop(eventCallback: OnDragEventCallback, dropOptions?: DropOptions): T; @@ -23292,7 +25658,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDragEnd(event: (event: DragEvent, extraParams?: string) => void): T; @@ -23323,7 +25690,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ allowDrop(value: Array | null): T; @@ -23343,7 +25711,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ draggable(value: boolean): T; @@ -23362,7 +25731,8 @@ declare class CommonMethod { * @returns { T } property value of type T. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dragPreview(value: CustomBuilder | DragItemInfo | string): T; @@ -23374,7 +25744,8 @@ declare class CommonMethod { * @returns { T } property value of type T. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ dragPreview(preview: CustomBuilder | DragItemInfo | string, config?: PreviewConfiguration): T; @@ -23394,7 +25765,8 @@ declare class CommonMethod { * @returns { T } property value of type T. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dragPreviewOptions(value: DragPreviewOptions, options?: DragInteractionOptions): T; @@ -23405,7 +25777,8 @@ declare class CommonMethod { * @returns { T } property value of type T. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onPreDrag(callback: Callback): T; @@ -23461,7 +25834,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ overlay(value: string | CustomBuilder | ComponentContent, options?: OverlayOptions): T; @@ -23480,7 +25854,7 @@ declare class CommonMethod { /** * Linear Gradient * angle: Angle of Linear Gradient. The default value is 180; - * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; + * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; * colors: Color description for gradients. * repeating: repeating. The default value is false * @@ -23493,7 +25867,7 @@ declare class CommonMethod { /** * Linear Gradient * angle: Angle of Linear Gradient. The default value is 180; - * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; + * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; * colors: Color description for gradients. * repeating: repeating. The default value is false * @@ -23507,7 +25881,7 @@ declare class CommonMethod { /** * Linear Gradient * angle: Angle of Linear Gradient. The default value is 180; - * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; + * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; * colors: Color description for gradients. * repeating: repeating. The default value is false * @@ -23522,7 +25896,7 @@ declare class CommonMethod { /** * Linear Gradient * angle: Angle of Linear Gradient. The default value is 180; - * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; + * direction: Direction of Linear Gradient. The default value is GradientDirection.Bottom; * colors: Color description for gradients. * repeating: repeating. The default value is false * @@ -23548,7 +25922,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ linearGradient(value: LinearGradientOptions): T; @@ -23565,7 +25940,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ linearGradient(options: Optional): T; @@ -23669,7 +26045,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sweepGradient(value: SweepGradientOptions): T; @@ -23688,7 +26065,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sweepGradient(options: Optional): T; @@ -23775,7 +26153,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ radialGradient(value: RadialGradientOptions): T; @@ -23792,7 +26171,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ radialGradient(options: Optional): T; @@ -23833,7 +26213,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ motionPath(value: MotionPathOptions): T; @@ -23873,7 +26254,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ shadow(value: ShadowOptions | ShadowStyle): T; @@ -23886,13 +26268,14 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ shadow(options: Optional): T; /** * Add a blendMode effect to the current component - * + * * @param { BlendMode } value - Different hybrid modes * @param { BlendApplyType } [type] - Different blend apply type * @returns { T } @@ -23911,7 +26294,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ blendMode(value: BlendMode, type?: BlendApplyType): T; @@ -23925,13 +26309,14 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ blendMode(mode: Optional, type?: BlendApplyType): T; /** * Add a blendMode effect to the current component.Cannot be used together with the blendMode interface. - * + * * @param { BlendMode | Blender } effect - When the effect type is BlendMode type, define Different hybrid modes. * When the effect type is Blender type, Define the corresponding blending effect. * @param { BlendApplyType } [type] - Different blend apply type @@ -23939,7 +26324,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ advancedBlendMode(effect: BlendMode | Blender, type?: BlendApplyType): T; @@ -23952,7 +26338,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clip(value: boolean): T; @@ -23965,7 +26352,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ clip(clip: Optional): T; @@ -24024,7 +26412,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clipShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; @@ -24037,7 +26426,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ clipShape(shape: Optional): T; @@ -24049,7 +26439,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ mask(value: ProgressMask): T; @@ -24061,7 +26452,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ mask(mask: Optional): T; @@ -24116,7 +26508,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maskShape(value: CircleShape | EllipseShape | PathShape | RectShape): T; @@ -24129,7 +26522,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ maskShape(shape: Optional): T; @@ -24140,8 +26534,9 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} * @test + * @arkts 1.1&1.2 */ key(value: string): T; @@ -24181,7 +26576,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ id(value: string): T; @@ -24210,7 +26606,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ geometryTransition(id: string): T; /** @@ -24232,7 +26629,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ geometryTransition(id: string, options?: GeometryTransitionOptions): T; @@ -24245,7 +26643,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ bindTips(message: TipsMessageType, options?: TipsOptions): T; @@ -24276,7 +26675,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bindPopup(show: boolean, popup: PopupOptions | CustomPopupOptions): T; @@ -24310,7 +26710,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bindMenu(content: Array | CustomBuilder, options?: MenuOptions): T; @@ -24335,7 +26736,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bindMenu(isShow: boolean, content: Array | CustomBuilder, options?: MenuOptions): T; @@ -24370,7 +26772,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bindContextMenu(content: CustomBuilder, responseType: ResponseType, options?: ContextMenuOptions): T; @@ -24384,7 +26787,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bindContextMenu(isShown: boolean, content: CustomBuilder, options?: ContextMenuOptions): T; @@ -24413,6 +26817,21 @@ declare class CommonMethod { */ bindContentCover(isShow: boolean, builder: CustomBuilder, type?: ModalTransition): T; + /** + * Bind content cover + * + * @param { boolean | Bindable} isShow - true means display content, false means hide content. + * @param { CustomBuilder } builder - the content to be displayed. + * @param { ModalTransition } [type] - transition type. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + bindContentCover(isShow: boolean | Bindable, builder: CustomBuilder, type?: ModalTransition): T; + /** * Bind content cover * @@ -24436,7 +26855,22 @@ declare class CommonMethod { * @atomicservice * @since 11 */ - bindContentCover(isShow: boolean, builder: CustomBuilder, options?: ContentCoverOptions): T; + bindContentCover(isShow: boolean , builder: CustomBuilder, options?: ContentCoverOptions): T; + + /** + * Bind content cover + * + * @param { boolean | Bindable } isShow - true means display content, false means hide content. + * @param { CustomBuilder } builder - the content to be displayed. + * @param { ContentCoverOptions } [options] - options of content cover. + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + bindContentCover(isShow: boolean | Bindable, builder: CustomBuilder, options?: ContentCoverOptions): T; /** * Bind sheet @@ -24460,9 +26894,25 @@ declare class CommonMethod { * @crossplatform * @atomicservice * @since 11 + * @arkts 1.1 */ bindSheet(isShow: boolean, builder: CustomBuilder, options?: SheetOptions): T; + /** + * Bind sheet + * + * @param { boolean | Bindable} isShow - true means display sheet, false means hide sheet. + * @param { CustomBuilder } builder - the sheet to be displayed. + * @param { SheetOptions } [options] - options of sheet. + * @returns { T } - template type + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + bindSheet(isShow: boolean | Bindable, builder: CustomBuilder, options?: SheetOptions): T; + /** * Sets styles for component state. * @@ -24499,7 +26949,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stateStyles(value: StateStyles): T; @@ -24519,7 +26970,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ restoreId(value: number): T; @@ -24562,7 +27014,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ onVisibleAreaChange(ratios: Array, event: VisibleAreaChangeCallback): T; @@ -24577,7 +27030,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ onVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; @@ -24590,7 +27044,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sphericalEffect(value: number): T; @@ -24603,7 +27058,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sphericalEffect(effect: Optional): T; @@ -24616,7 +27072,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lightUpEffect(value: number): T; @@ -24629,7 +27086,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ lightUpEffect(degree: Optional): T; @@ -24641,7 +27099,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pixelStretchEffect(options: PixelStretchEffectOptions): T; @@ -24653,7 +27112,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ pixelStretchEffect(options: Optional): T; @@ -24678,7 +27138,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardShortcut(value: string | FunctionKey, keys: Array, action?: () => void): T; @@ -24710,7 +27171,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityGroup(value: boolean): T; @@ -24724,7 +27186,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions): T; @@ -24756,10 +27219,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityText(value: string): T; - + /** * Sets accessibility next focus id * @param { string } nextId - set component next accessibility focus id @@ -24768,10 +27232,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityNextFocusId(nextId: string): T; - + /** * Sets the accessibility default foucs flag * @param { boolean } focus - if the component is accessibility default focus,focus set true @@ -24780,10 +27245,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityDefaultFocus(focus: boolean): T; - + /** * Sets accessibility same page mode * @param { AccessibilitySamePageMode } pageMode - accessibility same page mode @@ -24792,7 +27258,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityUseSamePage(pageMode: AccessibilitySamePageMode): T; @@ -24804,7 +27271,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityScrollTriggerable(isTriggerable: boolean): T; @@ -24817,10 +27285,11 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityText(text: Resource): T; - + /** * Sets accessibility role,role indicates the custom type of the component * @param { AccessibilityRoleType } role - set accessibility component type @@ -24829,7 +27298,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityRole(role: AccessibilityRoleType): T; @@ -24841,7 +27311,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAccessibilityFocus(callback: AccessibilityFocusCallback): T; @@ -24854,7 +27325,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityTextHint(value: string): T; @@ -24886,7 +27358,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityDescription(value: string): T; @@ -24899,7 +27372,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityDescription(description: Resource): T; @@ -24931,7 +27405,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityLevel(value: string): T; @@ -24954,7 +27429,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityVirtualNode(builder: CustomBuilder): T; @@ -24967,7 +27443,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityChecked(isCheck: boolean): T; @@ -24980,7 +27457,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilitySelected(isSelect: boolean): T; @@ -25001,7 +27479,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ obscured(reasons: Array): T; @@ -25022,7 +27501,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reuseId(id: string): T; @@ -25034,7 +27514,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ reuse(options: ReuseOptions): T; @@ -25066,7 +27547,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ renderFit(fitMode: RenderFit): T; @@ -25079,7 +27561,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ renderFit(fitMode: Optional): T; @@ -25112,7 +27595,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ gestureModifier(modifier: GestureModifier): T; @@ -25123,7 +27607,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBrightness(params: BackgroundBrightnessOptions): T; @@ -25134,7 +27619,8 @@ declare class CommonMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBrightness(options: Optional): T; @@ -25155,7 +27641,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T; @@ -25167,7 +27654,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback): T; @@ -25180,8 +27668,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ onGestureRecognizerJudgeBegin(callback: GestureRecognizerJudgeBeginCallback, exposeInnerGesture: boolean): T; @@ -25193,7 +27681,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shouldBuiltInRecognizerParallelWith(callback: ShouldBuiltInRecognizerParallelWithCallback): T; @@ -25214,7 +27703,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ monopolizeEvents(monopolize: boolean): T; @@ -25226,7 +27716,8 @@ declare class CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onTouchIntercept(callback: Callback): T; @@ -25239,7 +27730,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSizeChange(event: SizeChangeCallback): T; @@ -25252,7 +27744,8 @@ declare class CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityFocusDrawLevel(drawLevel: FocusDrawLevel): T; } @@ -25293,6 +27786,18 @@ declare class CommonMethod { */ declare class CommonAttribute extends CommonMethod {} +/** + * CommonAttribute for ide. + * + * @typedef { CommonMethod } CommonAttribute + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type CommonAttribute = CommonMethod /** * CommonInterface for ide. * @@ -25337,7 +27842,7 @@ interface CommonInterface { */ /** * Constructor - * + * * @returns { CommonAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @form @@ -25354,7 +27859,7 @@ interface CommonInterface { */ /** * Constructor - * + * * @returns { CommonAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -25473,7 +27978,8 @@ declare type CustomBuilder = (() => any) | void; * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OverlayOptions { /** @@ -25508,10 +28014,11 @@ declare interface OverlayOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ align?: Alignment; - + /** * Defines offset type. * @@ -25544,7 +28051,8 @@ declare interface OverlayOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: OverlayOffset; } @@ -25557,7 +28065,8 @@ declare interface OverlayOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OverlayOffset { /** @@ -25592,7 +28101,8 @@ declare interface OverlayOffset { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; /** @@ -25627,7 +28137,8 @@ declare interface OverlayOffset { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; } @@ -25642,7 +28153,8 @@ declare interface OverlayOffset { * @typedef { [ number, number ] } FractionStop * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type FractionStop = [ number, number ]; @@ -25678,7 +28190,8 @@ declare type FractionStop = [ number, number ]; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CommonShapeMethod extends CommonMethod { /** @@ -25694,7 +28207,8 @@ declare class CommonShapeMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @form - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -25734,7 +28248,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stroke(value: ResourceColor): T; @@ -25774,7 +28289,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fill(value: ResourceColor): T; @@ -25814,7 +28330,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeDashOffset(value: number | string): T; @@ -25854,7 +28371,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeLineCap(value: LineCapStyle): T; @@ -25894,7 +28412,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeLineJoin(value: LineJoinStyle): T; @@ -25934,7 +28453,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeMiterLimit(value: number | string): T; @@ -25974,7 +28494,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeOpacity(value: number | string | Resource): T; @@ -26014,7 +28535,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fillOpacity(value: number | string | Resource): T; @@ -26054,7 +28576,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth(value: Length): T; @@ -26094,7 +28617,8 @@ declare class CommonShapeMethod extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ antiAlias(value: boolean): T; @@ -26137,6 +28661,20 @@ declare class CommonShapeMethod extends CommonMethod { * @since 11 */ strokeDashArray(value: Array): T; + + /** + * Sets the gap for the border. + * + * @param { Array } value + * @returns { T } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + strokeDashArray(value: Array): T; } /** @@ -26161,7 +28699,8 @@ declare class CommonShapeMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LinearGradient { /** @@ -26186,7 +28725,8 @@ declare interface LinearGradient { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ angle?: number | string; /** @@ -26211,7 +28751,8 @@ declare interface LinearGradient { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: GradientDirection; /** @@ -26245,7 +28786,8 @@ declare interface LinearGradient { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ colors: Array<[ResourceColor, number]>; /** @@ -26270,7 +28812,8 @@ declare interface LinearGradient { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ repeating?: boolean; } @@ -26283,7 +28826,8 @@ declare interface LinearGradient { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PixelRoundPolicy { /** @@ -26295,7 +28839,8 @@ declare interface PixelRoundPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ start?: PixelRoundCalcPolicy; @@ -26308,7 +28853,8 @@ declare interface PixelRoundPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: PixelRoundCalcPolicy; @@ -26321,7 +28867,8 @@ declare interface PixelRoundPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ end?: PixelRoundCalcPolicy; @@ -26334,7 +28881,8 @@ declare interface PixelRoundPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: PixelRoundCalcPolicy; } @@ -26345,7 +28893,8 @@ declare interface PixelRoundPolicy { * @interface LinearGradientBlurOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LinearGradientBlurOptions { /** @@ -26354,7 +28903,8 @@ declare interface LinearGradientBlurOptions { * @type { FractionStop[] } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fractionStops: FractionStop[]; /** @@ -26363,19 +28913,21 @@ declare interface LinearGradientBlurOptions { * @type { GradientDirection } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ direction: GradientDirection; } /** * Define motion blur anchor coordinates. - * + * * @interface MotionBlurAnchor * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MotionBlurAnchor { /** @@ -26384,7 +28936,8 @@ declare interface MotionBlurAnchor { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; /** @@ -26393,19 +28946,21 @@ declare interface MotionBlurAnchor { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } /** * Define motion blur options. - * + * * @interface MotionBlurOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MotionBlurOptions { /** @@ -26414,16 +28969,18 @@ declare interface MotionBlurOptions { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius: number; /** * Define motion blur anchor coordinates. - * + * * @type { MotionBlurAnchor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ anchor: MotionBlurAnchor; } @@ -26610,7 +29167,8 @@ declare interface LayoutChild { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GeometryInfo extends SizeResult { /** @@ -26628,7 +29186,8 @@ declare interface GeometryInfo extends SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth: EdgeWidth; @@ -26647,7 +29206,8 @@ declare interface GeometryInfo extends SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ margin: Margin, @@ -26666,7 +29226,8 @@ declare interface GeometryInfo extends SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ padding: Padding, } @@ -26686,7 +29247,8 @@ declare interface GeometryInfo extends SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Layoutable { /** @@ -26704,7 +29266,8 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ measureResult: MeasureResult, @@ -26715,7 +29278,8 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ uniqueId?: number; @@ -26734,7 +29298,8 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ layout(position: Position): void, @@ -26745,7 +29310,8 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getMargin() : DirectionalEdgesT, @@ -26756,10 +29322,11 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getPadding() : DirectionalEdgesT, - + /** * Call this method to get the borderWidth of sub component. * @@ -26767,7 +29334,8 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getBorderWidth() : DirectionalEdgesT, } @@ -26787,7 +29355,8 @@ declare interface Layoutable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Measurable { /** @@ -26797,7 +29366,8 @@ declare interface Measurable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ uniqueId?: number; @@ -26818,7 +29388,8 @@ declare interface Measurable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ measure(constraint: ConstraintSizeOptions) : MeasureResult, @@ -26829,7 +29400,8 @@ declare interface Measurable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getMargin() : DirectionalEdgesT, @@ -26840,7 +29412,8 @@ declare interface Measurable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getPadding() : DirectionalEdgesT, @@ -26851,7 +29424,8 @@ declare interface Measurable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getBorderWidth() : DirectionalEdgesT, } @@ -26871,7 +29445,8 @@ declare interface Measurable { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SizeResult { /** @@ -26889,7 +29464,8 @@ declare interface SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width: number, @@ -26908,7 +29484,8 @@ declare interface SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height: number, } @@ -26930,10 +29507,11 @@ declare interface SizeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MeasureResult extends SizeResult { - + } /** @@ -26954,6 +29532,30 @@ declare interface MeasureResult extends SizeResult { */ declare type NavDestinationInfo = import('../api/@ohos.arkui.observer').default.NavDestinationInfo; + +/** + * The navigation destination information. + * + * @typedef {uiObserver.NavDestinationInfo} NavDestinationInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type NavDestinationInfo = uiObserver.NavDestinationInfo; +/** + * The navigation information. + * + * @typedef { uiObserver.NavigationInfo } NavigationInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type NavigationInfo = uiObserver.NavigationInfo; + /** * The navigation information. * @@ -26976,6 +29578,18 @@ declare type NavigationInfo = import('../api/@ohos.arkui.observer').default.Navi */ declare type RouterPageInfo = import('../api/@ohos.arkui.observer').default.RouterPageInfo; +/** + * The router page information. + * + * @typedef {uiObserver.RouterPageInfo} RouterPageInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type RouterPageInfo = uiObserver.RouterPageInfo; + /** * UIContext * @@ -27016,6 +29630,18 @@ declare type DrawContext = import('../api/arkui/Graphics').DrawContext; */ declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.VisualEffect; +/** + * VisualEffect + * + * @typedef { import('../api/@ohos.graphics.uiEffect').default.VisualEffect } VisualEffect + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type VisualEffect = uiEffect.VisualEffect; + /** * Filter @@ -27028,6 +29654,18 @@ declare type VisualEffect = import('../api/@ohos.graphics.uiEffect').default.Vis */ declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; +/** + * Filter + * + * @typedef { import('../api/@ohos.graphics.uiEffect').default.Filter } Filter + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type Filter = uiEffect.Filter; + /** * Blender * @@ -27039,6 +29677,18 @@ declare type Filter = import('../api/@ohos.graphics.uiEffect').default.Filter; */ declare type Blender = import('../api/@ohos.graphics.uiEffect').default.Blender; +/** + * Blender + * + * @typedef { import('../api/@ohos.graphics.uiEffect').default.Blender } Blender + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @form + * @since 20 + * @arkts 1.2 + */ +declare type Blender = uiEffect.Blender; + /** * ComponentContent. * @@ -27071,6 +29721,17 @@ declare type Theme = import('../api/@ohos.arkui.theme').Theme; */ declare type PromptActionDialogController = import('../api/@ohos.promptAction').promptAction.DialogController; +/** + * Import the DialogController type from promptAction. + * + * @typedef { promptAction.DialogController } PromptActionDialogController + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type PromptActionDialogController = promptAction.DialogController; + /** * Custom Component * @@ -27135,6 +29796,7 @@ declare class CustomComponent extends BaseCustomComponent { */ aboutToReuse?(params: { [key: string]: unknown }): void; + /** * Custom component override this method to layout each of its sub components. * @@ -27176,7 +29838,7 @@ declare class CustomComponentV2 extends BaseCustomComponent { /** * aboutToReuse Method for @ComponentV2, it is executed when fetching instance of custom component from RecyclePool. * It is different from the @Reusable in CustomComponent, there is no param parameter in this callback. - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -27240,16 +29902,16 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToAppear Method * - * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. - * + * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * aboutToAppear Method * - * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. - * + * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 @@ -27257,8 +29919,8 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToAppear Method * - * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. - * + * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form @@ -27267,8 +29929,8 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToAppear Method * - * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. - * + * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form @@ -27278,8 +29940,8 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToAppear Method and it is migrated from class CustomComponent. * - * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. - * + * The aboutToAppear function is executed after a new instance of the custom component is created, before its build() function is executed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form @@ -27291,16 +29953,16 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToDisappear Method * - * The aboutToDisappear function executes before a custom component is destroyed. - * + * The aboutToDisappear function executes before a custom component is destroyed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ /** * aboutToDisappear Method * - * The aboutToDisappear function executes before a custom component is destroyed. - * + * The aboutToDisappear function executes before a custom component is destroyed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 9 @@ -27308,8 +29970,8 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToDisappear Method * - * The aboutToDisappear function executes before a custom component is destroyed. - * + * The aboutToDisappear function executes before a custom component is destroyed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form @@ -27318,8 +29980,8 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToDisappear Method * - * The aboutToDisappear function executes before a custom component is destroyed. - * + * The aboutToDisappear function executes before a custom component is destroyed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form @@ -27329,8 +29991,8 @@ declare class BaseCustomComponent extends CommonAttribute { /** * aboutToDisappear Method and it is migrated from class CustomComponent. * - * The aboutToDisappear function executes before a custom component is destroyed. - * + * The aboutToDisappear function executes before a custom component is destroyed. + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @form @@ -27339,6 +30001,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ aboutToDisappear?(): void; + /** * aboutToRecycle Method * @@ -27364,9 +30027,10 @@ declare class BaseCustomComponent extends CommonAttribute { */ aboutToRecycle?(): void; + /** * The onWillApplyTheme function is a custom hook to get active theme object from the context - * + * * @param { Theme } theme - Custom theme init params. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -27375,7 +30039,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ /** * The onWillApplyTheme function is a custom hook to get active theme object from the context, it is migrated from class CustomComponent. - * + * * @param { Theme } theme - Custom theme init params. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -27384,6 +30048,8 @@ declare class BaseCustomComponent extends CommonAttribute { */ onWillApplyTheme?(theme: Theme): void; + + /** * Custom component override this method to layout each of its sub components. * @@ -27418,6 +30084,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ onPlaceChildren?(selfLayoutInfo: GeometryInfo, children: Array, constraint: ConstraintSizeOptions): void; + /** * Custom component override this method to measure each of its sub components. * @param { GeometryInfo } selfLayoutInfo @@ -27452,11 +30119,12 @@ declare class BaseCustomComponent extends CommonAttribute { */ onMeasureSize?(selfLayoutInfo: GeometryInfo, children: Array, constraint: ConstraintSizeOptions): SizeResult; + /** * onPageShow Method - * + * * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ @@ -27464,7 +30132,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onPageShow Method * * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -27473,7 +30141,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onPageShow Method * * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -27483,7 +30151,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onPageShow Method and it is migrated from class CustomComponent. * * The page is triggered once each time it is displayed, including scenarios such as the routing process and the application entering the foreground - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -27491,11 +30159,12 @@ declare class BaseCustomComponent extends CommonAttribute { */ onPageShow?(): void; + /** * onPageHide Method * * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 */ @@ -27503,7 +30172,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onPageHide Method * * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 @@ -27512,7 +30181,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onPageHide Method * * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -27522,7 +30191,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onPageHide Method and it is migrated from class CustomComponent. * * It is triggered once each time the page is hidden, including scenarios such as the routing process and the application entering the background - * + * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice @@ -27567,6 +30236,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ onFormRecycle?(): string; + /** * onFormRecover Method, this is only for ArkTS form * @@ -27584,7 +30254,8 @@ declare class BaseCustomComponent extends CommonAttribute { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ /** * onFormRecover Method, this is only for ArkTS form, it is migrated from class CustomComponent. @@ -27598,11 +30269,12 @@ declare class BaseCustomComponent extends CommonAttribute { */ onFormRecover?(statusData: string): void; + /** * onBackPress Method * * Triggered when the user clicks the back button - * + * * @returns { void | boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 7 @@ -27611,7 +30283,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onBackPress Method * * Triggered when the user clicks the back button - * + * * @returns { void | boolean } true means that the page itself processes the return logic. * false means that the default return logic is used. * If no value is returned, the default return logic is used. @@ -27623,7 +30295,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onBackPress Method * * Triggered when the user clicks the back button - * + * * @returns { void | boolean } true means that the page itself processes the return logic. * false means that the default return logic is used. * If no value is returned, the default return logic is used. @@ -27636,7 +30308,7 @@ declare class BaseCustomComponent extends CommonAttribute { * onBackPress Method and it is migrated from class CustomComponent. * * Triggered when the user clicks the back button - * + * * @returns { void | boolean } true means that the page itself processes the return logic. * false means that the default return logic is used. * If no value is returned, the default return logic is used. @@ -27647,6 +30319,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ onBackPress?(): void | boolean; + /** * PageTransition Method. * Implement Animation when enter this page or move to other pages. @@ -27669,7 +30342,8 @@ declare class BaseCustomComponent extends CommonAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * PageTransition Method and it is migrated from class CustomComponent. @@ -27682,6 +30356,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ pageTransition?(): void; + /** * Get current UIContext * @@ -27757,7 +30432,7 @@ declare class BaseCustomComponent extends CommonAttribute { * @since 18 */ queryNavDestinationInfo(): NavDestinationInfo | undefined; - + /** * Queries the navigation destination information. * @@ -27772,7 +30447,7 @@ declare class BaseCustomComponent extends CommonAttribute { /** * Query the navigation information of the current custom component. - * + * * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -27781,7 +30456,7 @@ declare class BaseCustomComponent extends CommonAttribute { */ /** * Query the navigation information of the current custom component and it is migrated from class CustomComponent. - * + * * @returns { NavigationInfo | undefined } The navigation information, or undefined if it is not available * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -27853,6 +30528,7 @@ declare class BaseCustomComponent extends CommonAttribute { * @since 18 */ onNewParam?(param: ESObject): void; + } /** * View @@ -27907,7 +30583,8 @@ declare class View { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RectResult { /** @@ -27924,7 +30601,8 @@ declare interface RectResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -27942,7 +30620,8 @@ declare interface RectResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; @@ -27960,7 +30639,8 @@ declare interface RectResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -27978,7 +30658,8 @@ declare interface RectResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -27998,7 +30679,8 @@ declare interface RectResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CaretOffset { /** @@ -28014,7 +30696,8 @@ declare interface CaretOffset { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -28031,10 +30714,11 @@ declare interface CaretOffset { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; - + /** * Get the y of the relative position. * @@ -28048,7 +30732,8 @@ declare interface CaretOffset { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -28060,7 +30745,8 @@ declare interface CaretOffset { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextContentControllerOptions { /** @@ -28070,7 +30756,8 @@ declare interface TextContentControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: number; } @@ -28088,7 +30775,8 @@ declare interface TextContentControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare abstract class TextContentControllerBase { /** @@ -28106,7 +30794,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getCaretOffset() : CaretOffset; @@ -28125,7 +30814,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getTextContentRect() : RectResult; @@ -28144,7 +30834,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getTextContentLineCount() : number; @@ -28157,7 +30848,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ addText(text: string, textOperationOptions?: TextContentControllerOptions): number; @@ -28168,7 +30860,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ deleteText(range?: TextRange): void; @@ -28179,7 +30872,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ getSelection(): TextRange; @@ -28188,7 +30882,8 @@ declare abstract class TextContentControllerBase { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ clearPreviewText(): void; @@ -28200,7 +30895,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getText(range?: TextRange): string; } @@ -28212,7 +30908,8 @@ declare abstract class TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ContentClipMode { /** @@ -28221,7 +30918,8 @@ declare enum ContentClipMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_ONLY = 0, @@ -28231,7 +30929,8 @@ declare enum ContentClipMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ BOUNDARY = 1, @@ -28241,7 +30940,8 @@ declare enum ContentClipMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ SAFE_AREA = 2, } @@ -28263,7 +30963,8 @@ declare enum ContentClipMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScrollableCommonMethod extends CommonMethod { /** @@ -28274,7 +30975,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBar(barState: BarState): T; @@ -28286,7 +30988,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBarColor(color: Color | number | string): T; @@ -28298,7 +31001,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBarWidth(value: number | string): T; @@ -28306,12 +31010,13 @@ declare class ScrollableCommonMethod extends CommonMethod { * Edge scrolling effect. * * @param { EdgeEffect } edgeEffect - edge scrolling effect. - * @param { EdgeEffectOptions } options - edge scrolling effect options. + * @param { EdgeEffectOptions } options - edge scrolling effect options. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): T; @@ -28324,7 +31029,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ fadingEdge(enabled: Optional, options?: FadingEdgeOptions): T; @@ -28332,11 +31038,12 @@ declare class ScrollableCommonMethod extends CommonMethod { * Nested scrolling options. * * @param { NestedScrollOptions } value - options for nested scrolling. - * @returns { T } + * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ nestedScroll(value: NestedScrollOptions): T; @@ -28344,11 +31051,12 @@ declare class ScrollableCommonMethod extends CommonMethod { * Whether to support scroll gestures by finger or mouse. * * @param { boolean } value - Whether to support scroll gestures by finger or mouse. - * @returns { T } + * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableScrollInteraction(value: boolean): T; @@ -28356,11 +31064,12 @@ declare class ScrollableCommonMethod extends CommonMethod { * Friction coefficient. * * @param { number | Resource } value - friction coefficient. - * @returns { T } + * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ friction(value: number | Resource): T; @@ -28413,7 +31122,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onReachStart(event: () => void): T; @@ -28425,7 +31135,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onReachEnd(event: () => void): T; @@ -28437,7 +31148,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStart(event: () => void): T; @@ -28449,7 +31161,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStop(event: () => void): T; @@ -28462,19 +31175,21 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ flingSpeedLimit(speedLimit: number): T; /** * Clip the content of the scrollable container, excluding background. - * + * * @param { ContentClipMode | RectShape } clip - A value from enum ContentClipMode or a customized clip rect. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ clipContent(clip: ContentClipMode | RectShape): T; @@ -28486,20 +31201,22 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ digitalCrownSensitivity(sensitivity: Optional): T; - + /** * Controls whether the scrollable scrolls back to top when status bar is clicked. - * + * * @param { boolean } backToTop - whether the scrollable scrolls back to top when status bar is clicked. * The default value is false. * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ backToTop(backToTop: boolean): T; } @@ -28509,7 +31226,8 @@ declare class ScrollableCommonMethod extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScrollResult { /** @@ -28518,7 +31236,8 @@ declare class ScrollResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offsetRemain: number; } @@ -28530,16 +31249,34 @@ declare class ScrollResult { * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. * @param { ScrollState } scrollState - current scroll state. * @param { ScrollSource } scrollSource - source of current scroll. - * @returns { void | ScrollResult } the remain offset for the scrollable, + * @returns { void | ScrollResult } the remain offset for the scrollable, * same as scrollOffset when no ScrollResult is returned. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice * @since 12 */ -declare type OnWillScrollCallback = +declare type OnWillScrollCallback = (scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | ScrollResult; +/** + * Called before scroll to allow developer to control real offset the Scrollable can scroll. + * + * @typedef { function } OnWillScrollCallback + * @param { number } scrollOffset - offset this frame will scroll, which may or may not be reached. + * @param { ScrollState } scrollState - current scroll state. + * @param { ScrollSource } scrollSource - source of current scroll. + * @returns { void | ScrollResult } the remain offset for the scrollable, + * same as scrollOffset when no ScrollResult is returned. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type OnWillScrollCallback = +(scrollOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => undefined | ScrollResult; + /** * On scroll callback using in scrollable onDidScroll. * @@ -28550,10 +31287,25 @@ declare type OnWillScrollCallback = * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) => void; +/** + * Defines the callback type used in onItemDragStart. + * + * @typedef { function } OnItemDragStartCallback + * @param { ItemDragInfo } event - Information about the dragged item. + * @param { number } itemIndex - The index number of the dragged item. + * @returns {CustomBuilder | undefined} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type OnItemDragStartCallback = (event: ItemDragInfo, itemIndex: number) => CustomBuilder | undefined; + /** * Defines the onMove callback. * @@ -28563,7 +31315,8 @@ declare type OnScrollCallback = (scrollOffset: number, scrollState: ScrollState) * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnMoveHandler = (from: number, to: number) => void; @@ -28574,7 +31327,8 @@ declare type OnMoveHandler = (from: number, to: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ItemDragEventHandler { /** @@ -28584,7 +31338,8 @@ declare interface ItemDragEventHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onLongPress?: Callback; @@ -28595,7 +31350,8 @@ declare interface ItemDragEventHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDragStart?: Callback; @@ -28606,7 +31362,8 @@ declare interface ItemDragEventHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onMoveThrough?: OnMoveHandler; @@ -28617,7 +31374,8 @@ declare interface ItemDragEventHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDrop?: Callback; } @@ -28657,6 +31415,44 @@ declare class DynamicNode { onMove(handler: Optional, eventHandler: ItemDragEventHandler): T; } +/** + * Define DynamicNode. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface DynamicNode { + /** + * Set the move action. + * + * @param { Optional } handler + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onMove(handler: Optional): this; + + /** + * Set the move action. + * + * @param { Optional } handler + * @param { ItemDragEventHandler } eventHandler + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onMove(handler: Optional, eventHandler: ItemDragEventHandler): this; +} + /** * Define EdgeEffect Options. * @@ -28672,7 +31468,8 @@ declare class DynamicNode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface EdgeEffectOptions { /** @@ -28690,7 +31487,8 @@ declare interface EdgeEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alwaysEnabled: boolean; @@ -28701,7 +31499,8 @@ declare interface EdgeEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ effectEdge?: number; } @@ -28713,7 +31512,8 @@ declare interface EdgeEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EffectEdge { @@ -28723,7 +31523,8 @@ declare enum EffectEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ START = 1, @@ -28733,7 +31534,8 @@ declare enum EffectEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ END = 2, } @@ -28744,7 +31546,8 @@ declare enum EffectEdge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ChildrenMainSize { /** @@ -28752,14 +31555,15 @@ declare class ChildrenMainSize { * * @param { number } childDefaultSize - default main size, in vp. If the main axis is vertical, it indicates height. * If the main axis is horizontal, it indicates width. - * @throws { BusinessError } 401 - Parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(childDefaultSize: number); @@ -28768,14 +31572,15 @@ declare class ChildrenMainSize { * * @param { number } value - default main size, in vp. If the main axis is vertical, it indicates height. * If the main axis is horizontal, it indicates width. - * @throws { BusinessError } 401 - Parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ set childDefaultSize(value: number); @@ -28787,7 +31592,8 @@ declare class ChildrenMainSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ get childDefaultSize(): number; @@ -28797,17 +31603,18 @@ declare class ChildrenMainSize { * @param { number } start - Zero-based index at which to start changing the children main size. * @param { number } [deleteCount] - Indicating the number of children main size to remove from start. * @param { Array } [childrenSize] - Add the new children main size, beginning from start. - * @throws { BusinessError } 401 - Parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} * @example splice(1, 0, [100]), Insert a child after first child, the child's main size is 100vp. * splice(1, 1), Delete the second child. * splice(1, 2, [100, 100]), Change the main size of the second and third children to 100vp. + * @arkts 1.1&1.2 */ splice(start: number, deleteCount?: number, childrenSize?: Array): void; @@ -28816,14 +31623,15 @@ declare class ChildrenMainSize { * * @param { number } index - index of child to be updated. * @param { number } childSize - new section options. - * @throws { BusinessError } 401 - Parameter error. Possible causes: + * @throws { BusinessError } 401 - Parameter error. Possible causes: *
1. Mandatory parameters are left unspecified. *
2. Incorrect parameters types. *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ update(index: number, childSize: number): void; } @@ -28834,7 +31642,8 @@ declare class ChildrenMainSize { * @interface BackgroundBrightnessOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BackgroundBrightnessOptions { @@ -28845,7 +31654,8 @@ declare interface BackgroundBrightnessOptions { * @type { number } -The default value is 0.0, value range: (0.0, +∞). * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rate: number; @@ -28857,7 +31667,8 @@ declare interface BackgroundBrightnessOptions { * @type { number } -The default value is 0.0, value range: [-1.0, 1.0]. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lightUpDegree: number; } @@ -28868,7 +31679,8 @@ declare interface BackgroundBrightnessOptions { * @interface PointLightStyle * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PointLightStyle { /** @@ -28878,7 +31690,8 @@ declare interface PointLightStyle { * @default undefined * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lightSource?: LightSource; /** @@ -28888,7 +31701,8 @@ declare interface PointLightStyle { * @default IlluminatedType.NONE * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ illuminated?: IlluminatedType; /** @@ -28898,7 +31712,8 @@ declare interface PointLightStyle { * @default 0 * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bloom?: number; } @@ -28909,7 +31724,8 @@ declare interface PointLightStyle { * @interface LightSource * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LightSource { /** @@ -28918,7 +31734,8 @@ declare interface LightSource { * @type { Dimension } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ positionX: Dimension; /** @@ -28927,7 +31744,8 @@ declare interface LightSource { * @type { Dimension } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ positionY: Dimension; /** @@ -28936,7 +31754,8 @@ declare interface LightSource { * @type { Dimension } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ positionZ: Dimension; /** @@ -28945,7 +31764,8 @@ declare interface LightSource { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ intensity: number; /** @@ -28954,7 +31774,8 @@ declare interface LightSource { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; } @@ -29024,6 +31845,8 @@ declare class WrappedBuilder { } + + /** * Defines the overall animation parameters of the keyframe animation. * @@ -29039,7 +31862,8 @@ declare class WrappedBuilder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface KeyframeAnimateParam { /** @@ -29059,7 +31883,8 @@ declare interface KeyframeAnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ delay?: number; @@ -29080,7 +31905,8 @@ declare interface KeyframeAnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iterations?: number; @@ -29099,7 +31925,8 @@ declare interface KeyframeAnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish?: () => void; @@ -29110,7 +31937,8 @@ declare interface KeyframeAnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ expectedFrameRateRange?: ExpectedFrameRateRange; } @@ -29130,7 +31958,8 @@ declare interface KeyframeAnimateParam { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface KeyframeState { /** @@ -29148,7 +31977,8 @@ declare interface KeyframeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ duration: number; @@ -29167,7 +31997,8 @@ declare interface KeyframeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | string | ICurve; @@ -29186,7 +32017,8 @@ declare interface KeyframeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ event: () => void; } @@ -29215,6 +32047,20 @@ declare interface Callback { (data: T): V; } +/** + * Defines the callback + * + * @typedef { function } Callback + * @param { T } data + * @returns { V } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export type Callback = (data: T) => V; + /** * Defines the callback type used in hover events. * The value of isHover indicates whether the mouse is hovering over the component. @@ -29226,9 +32072,10 @@ declare interface Callback { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void +declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void; /** * Defines the callback type used in accessibility hover events. @@ -29241,9 +32088,10 @@ declare type HoverCallback = (isHover: boolean, event: HoverEvent) => void * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void +declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHoverEvent) => void; /** * Defines the options about VisibleAreaEvent. @@ -29252,7 +32100,8 @@ declare type AccessibilityCallback = (isHover: boolean, event: AccessibilityHove * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface VisibleAreaEventOptions { /** @@ -29262,7 +32111,8 @@ declare interface VisibleAreaEventOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ratios: Array; @@ -29274,7 +32124,8 @@ declare interface VisibleAreaEventOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ expectedUpdateInterval?: number; } @@ -29301,7 +32152,8 @@ declare interface VisibleAreaEventOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: number) => void; @@ -29312,7 +32164,8 @@ declare type VisibleAreaChangeCallback = (isExpanding: boolean, currentRatio: nu * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface UICommonEvent { /** @@ -29322,7 +32175,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnClick(callback: Callback | undefined): void; @@ -29333,7 +32187,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnTouch(callback: Callback | undefined): void; @@ -29344,18 +32199,20 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnAppear(callback: Callback | undefined): void; /** * Set or reset the callback is triggered when component uninstallation disappears. - * + * * @param { Callback | undefined } callback - The callback will be triggered when component uninstallation disappears. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnDisappear(callback: Callback | undefined): void; @@ -29367,7 +32224,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnKeyEvent(callback: Callback | undefined): void; @@ -29378,7 +32236,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnFocus(callback: Callback | undefined): void; @@ -29389,18 +32248,20 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnBlur(callback: Callback | undefined): void; /** * Set or reset the callback which is triggered when has a hover event. - * + * * @param { HoverCallback | undefined } callback - The callback will be triggered when has a hover event. If set undefined will reset the target callback. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnHover(callback: HoverCallback | undefined): void; @@ -29411,7 +32272,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnMouse(callback: Callback | undefined): void; @@ -29422,7 +32284,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnSizeChange(callback: SizeChangeCallback | undefined): void; @@ -29435,7 +32298,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setOnVisibleAreaApproximateChange(options: VisibleAreaEventOptions, event: VisibleAreaChangeCallback | undefined): void; } @@ -29447,7 +32311,8 @@ declare interface UICommonEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface UIGestureEvent { /** @@ -29463,6 +32328,20 @@ declare interface UIGestureEvent { */ addGesture(gesture: GestureHandler, priority?: GesturePriority, mask?: GestureMask): void; + /** + * Add a gesture bound to the component. + * + * @param { GestureHandler } gesture - gesture indicates the gesture bound to a component. + * @param { GesturePriority } priority - priority indicates the gesture's priority. + * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + addGesture(gesture: GestureHandler, priority?: GesturePriority, mask?: GestureMask): void; + /** * Add a parallel gesture bound to the component. * @@ -29474,6 +32353,19 @@ declare interface UIGestureEvent { * @since 12 */ addParallelGesture(gesture: GestureHandler, mask?: GestureMask): void; + /** + * Add a parallel gesture bound to the component. + * + * @param { GestureHandler } gesture - gesture indicates the gesture bound to a component. + * @param { GestureMask } mask - mask indicates the gesture's GestureMask value. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + addParallelGesture(gesture: GestureHandler, mask?: GestureMask): void; + /** * Remove the gesture that is bound to the component and marked as tag. @@ -29482,7 +32374,8 @@ declare interface UIGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeGestureByTag(tag: string): void; @@ -29492,29 +32385,32 @@ declare interface UIGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clearGestures(): void; } /** * Defines the gesture modifier. - * + * * @interface GestureModifier * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GestureModifier { /** * Defines the gesture update function. - * + * * @param { UIGestureEvent } event * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ applyGesture(event: UIGestureEvent): void; } @@ -29526,7 +32422,8 @@ declare interface GestureModifier { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SelectionOptions { /** @@ -29536,7 +32433,8 @@ declare interface SelectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ menuPolicy?: MenuPolicy; } @@ -29548,7 +32446,8 @@ declare interface SelectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FocusMovement { /** @@ -29558,7 +32457,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ forward?: string; /** @@ -29568,7 +32468,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backward?: string; /** @@ -29578,7 +32479,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ up?: string; /** @@ -29588,7 +32490,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ down?: string; /** @@ -29598,7 +32501,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ left?: string; /** @@ -29608,7 +32512,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ right?: string; } @@ -29620,7 +32525,8 @@ declare interface FocusMovement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum KeyboardAvoidMode { /** @@ -29629,7 +32535,8 @@ declare enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -29639,7 +32546,8 @@ declare enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 1, } @@ -29651,7 +32559,8 @@ declare enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HoverModeAreaType { @@ -29661,7 +32570,8 @@ declare enum HoverModeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ TOP_SCREEN = 0, @@ -29671,19 +32581,21 @@ declare enum HoverModeAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM_SCREEN = 1, } /** * Defines a range of dates. - * + * * @interface DateRange * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DateRange { /** @@ -29693,7 +32605,8 @@ declare interface DateRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ start?: Date; @@ -29704,7 +32617,64 @@ declare interface DateRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ end?: Date; } + +/** + * Defines the format for displaying dates and times. + * + * @typedef { intl.DateTimeOptions } DateTimeOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type DateTimeOptions = intl.DateTimeOptions; + +/** + * Defines a bindable property + * @interface Bindable + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export declare interface Bindable { + /** + * Defines value of the bindable property. + * @type { T } + * @readonly + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + readonly value: T; + + /** + * Defines the callback of the bindable property which will be invork when the property is changed.. + * @type { Callback } + * @readonly + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + * @arkts 1.2 + */ + readonly onChange: Callback; +} + +/** + * Convert to a bindable property. + * + * @param { T } value - indicate the value of a state property. + * @returns { Bindable } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + * @arkts 1.2 + */ +export declare function $$(value: T): Bindable; diff --git a/api/@internal/component/ets/component3d.d.ts b/api/@internal/component/ets/component3d.d.ts index 86a17a686539a4eab6b12e213cee4d652183e761..bb6051b8e6615252a0fd61aeb5c717ea2c94e4f6 100644 --- a/api/@internal/component/ets/component3d.d.ts +++ b/api/@internal/component/ets/component3d.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Scene } from './../../../api/@ohos.graphics.scene'; +import { ResourceStr, Dimension } from './units'; +import { CommonMethod } from './common'; +/*** endif */ + /** * Provides methods for controlling the 3d scene * @@ -33,7 +39,8 @@ declare type Scene = import('../api/@ohos.graphics.scene').Scene; * @enum { number } * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ModelType { /** @@ -41,7 +48,8 @@ declare enum ModelType { * * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TEXTURE = 0, @@ -50,7 +58,8 @@ declare enum ModelType { * * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SURFACE = 1, } @@ -61,7 +70,8 @@ declare enum ModelType { * @interface SceneOptions * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SceneOptions { /** @@ -70,7 +80,8 @@ declare interface SceneOptions { * @type { ?(ResourceStr | Scene) } * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scene?: ResourceStr | Scene; @@ -81,7 +92,8 @@ declare interface SceneOptions { * @default ModelType.SURFACE * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ modelType?: ModelType; } @@ -92,7 +104,9 @@ declare interface SceneOptions { * @interface Component3DInterface * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + * @component */ interface Component3DInterface { /** @@ -102,7 +116,8 @@ interface Component3DInterface { * @returns { Component3DAttribute } * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (sceneOptions?: SceneOptions): Component3DAttribute; } @@ -111,7 +126,8 @@ interface Component3DInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class Component3DAttribute extends CommonMethod { /** @@ -121,7 +137,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ environment(uri: ResourceStr): Component3DAttribute; @@ -133,7 +150,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customRender(uri: ResourceStr, selfRenderUpdate: boolean): Component3DAttribute; @@ -144,7 +162,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shader(uri: ResourceStr): Component3DAttribute; @@ -155,7 +174,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shaderImageTexture(uri: ResourceStr): Component3DAttribute; @@ -166,7 +186,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shaderInputBuffer(buffer: Array): Component3DAttribute; @@ -177,7 +198,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderWidth(value: Dimension): Component3DAttribute; @@ -188,7 +210,8 @@ declare class Component3DAttribute extends CommonMethod { * @returns { Component3DAttribute } The attribute of the component3D * @syscap SystemCapability.ArkUi.Graphics3D * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderHeight(value: Dimension): Component3DAttribute; } diff --git a/api/@internal/component/ets/container_span.d.ts b/api/@internal/component/ets/container_span.d.ts index aa555965ff5a376b23918f47ae722555a6d84828..93349f5594110fdd20fb8b40db8e0634d890e2ac 100644 --- a/api/@internal/component/ets/container_span.d.ts +++ b/api/@internal/component/ets/container_span.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { TextBackgroundStyle } from './span'; +import { AttributeModifier } from './common'; +/*** endif */ + /** * Span container interface. * @@ -33,7 +38,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ContainerSpanInterface { /** @@ -51,7 +57,8 @@ interface ContainerSpanInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (): ContainerSpanAttribute; } @@ -69,7 +76,8 @@ interface ContainerSpanInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ContainerSpanAttribute { /** @@ -89,7 +97,8 @@ declare class ContainerSpanAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textBackgroundStyle(style: TextBackgroundStyle): ContainerSpanAttribute; @@ -101,7 +110,8 @@ declare class ContainerSpanAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ attributeModifier(modifier: AttributeModifier): ContainerSpanAttribute; } diff --git a/api/@internal/component/ets/content_slot.d.ts b/api/@internal/component/ets/content_slot.d.ts index bd90fd20c45908b87e2a06683be939ab9d27fd1e..79d291376e5b609e3da7154bdc6f034118edba0f 100644 --- a/api/@internal/component/ets/content_slot.d.ts +++ b/api/@internal/component/ets/content_slot.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Content } from '../../@ohos.arkui.node'; +/*** endif */ + /** * Define Content type * @@ -35,7 +39,8 @@ declare type Content = import('../api/@ohos.arkui.node').Content; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ContentSlotAttribute { } @@ -47,7 +52,8 @@ declare class ContentSlotAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ContentSlotInterface { /** @@ -58,7 +64,8 @@ interface ContentSlotInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (content: Content): ContentSlotAttribute; } diff --git a/api/@internal/component/ets/context_menu.d.ts b/api/@internal/component/ets/context_menu.d.ts index d730292d8564a43abe2d2699314940fbb13de728..02ffc4fc2c5ace136ec99f1e69d8447de887ca0b 100644 --- a/api/@internal/component/ets/context_menu.d.ts +++ b/api/@internal/component/ets/context_menu.d.ts @@ -64,4 +64,5 @@ declare class ContextMenu { * @useinstead ohos.arkui.UIContext.ContextMenuController#close */ static close(); + } diff --git a/api/@internal/component/ets/counter.d.ts b/api/@internal/component/ets/counter.d.ts index 0331a32e75de4ef8ff57b97a4e82836c4f0c8a38..622887fc1aeaf3716bc69a086aec56f869926b0a 100644 --- a/api/@internal/component/ets/counter.d.ts +++ b/api/@internal/component/ets/counter.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common' +import { VoidCallback } from './units' +/*** endif */ + /** * Counter component, which provides corresponding increment or decrement counting operations. * @@ -50,7 +55,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CounterInterface { /** @@ -85,7 +91,8 @@ interface CounterInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): CounterAttribute; } @@ -122,7 +129,8 @@ interface CounterInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CounterAttribute extends CommonMethod { /** @@ -172,7 +180,8 @@ declare class CounterAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onInc(event: VoidCallback): CounterAttribute; @@ -223,7 +232,8 @@ declare class CounterAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDec(event: VoidCallback): CounterAttribute; @@ -244,7 +254,8 @@ declare class CounterAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableDec(value: boolean): CounterAttribute; @@ -265,7 +276,8 @@ declare class CounterAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableInc(value: boolean): CounterAttribute; } diff --git a/api/@internal/component/ets/custom_dialog_controller.d.ts b/api/@internal/component/ets/custom_dialog_controller.d.ts index d0a5591578d84d418678b5ffb3589bbfa79b3f5a..9d3c60c4a44bbc104f02a549e36a58a156909c3c 100644 --- a/api/@internal/component/ets/custom_dialog_controller.d.ts +++ b/api/@internal/component/ets/custom_dialog_controller.d.ts @@ -18,6 +18,20 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { + Rectangle, AnimateParam, Callback, ShadowOptions, ShadowStyle, KeyboardAvoidMode, BlurStyle, HoverModeAreaType, + DismissReason, BackgroundBlurStyleOptions, BackgroundEffectOptions +} from './common'; +import { CustomBuilder } from './builder'; +import { DialogAlignment } from './alertDialog'; +import { Offset, ResourceColor, Dimension, BorderRadiuses, EdgeWidths, EdgeColors, EdgeStyles } from './units'; +import { BorderStyle } from './enums'; +import { LengthMetrics } from '../Graphics'; +import { LevelMode, LevelOrder, ImmersiveMode } from '../../@ohos.promptAction'; +import { CustomBuilder } from './builder'; +/*** endif */ + /** * Defines the options of CustomDialogController. * @@ -40,7 +54,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CustomDialogControllerOptions { /** @@ -69,6 +84,18 @@ declare interface CustomDialogControllerOptions { */ builder: any; + /** + * Custom builder function. + * + * @type { CustomBuilder } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + builder: CustomBuilder; + /** * Defines the cancel function. * @@ -91,7 +118,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cancel?: () => void; @@ -117,7 +145,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ autoCancel?: boolean; @@ -143,7 +172,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: DialogAlignment; @@ -169,7 +199,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Offset; @@ -195,7 +226,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ customStyle?: boolean; @@ -221,7 +253,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ gridCount?: number; @@ -240,7 +273,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskColor?: ResourceColor; @@ -259,7 +293,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskRect?: Rectangle; @@ -278,7 +313,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ openAnimation?: AnimateParam; @@ -297,7 +333,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ closeAnimation?: AnimateParam; @@ -317,7 +354,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showInSubWindow?: boolean; @@ -336,7 +374,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -355,7 +394,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cornerRadius?: Dimension | BorderRadiuses; @@ -374,7 +414,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isModal?: boolean; @@ -385,7 +426,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDismiss?: Callback; @@ -396,7 +438,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension; @@ -407,7 +450,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height?: Dimension; @@ -418,7 +462,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth?: Dimension | EdgeWidths; @@ -429,7 +474,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor?: ResourceColor | EdgeColors; @@ -440,7 +486,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderStyle?: BorderStyle | EdgeStyles; @@ -451,7 +498,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -463,7 +511,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -474,7 +523,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -485,7 +535,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -497,7 +548,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAvoidMode?: KeyboardAvoidMode; @@ -509,7 +561,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -521,7 +574,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -532,7 +586,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: Callback; @@ -543,7 +598,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: Callback; @@ -554,7 +610,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: Callback; @@ -565,7 +622,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: Callback; @@ -576,7 +634,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAvoidDistance?: LengthMetrics; @@ -588,7 +647,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ levelMode?: LevelMode; @@ -599,7 +659,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ levelUniqueId?: number; @@ -611,7 +672,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ immersiveMode?: ImmersiveMode; @@ -623,7 +685,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ levelOrder?: LevelOrder; @@ -635,7 +698,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ focusable?: boolean; } @@ -647,7 +711,8 @@ declare interface CustomDialogControllerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DismissDialogAction { /** @@ -657,7 +722,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dismiss: Callback; @@ -668,7 +734,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reason: DismissReason; } @@ -692,7 +759,8 @@ declare interface DismissDialogAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CustomDialogController { /** @@ -717,7 +785,8 @@ declare class CustomDialogController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: CustomDialogControllerOptions); @@ -744,6 +813,17 @@ declare class CustomDialogController { */ open(); + /** + * Display the content of the customized pop-up window. If the content has been displayed, it does not take effect. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + open(): void; + /** * Closes the custom pop-up window. If the window is closed, the window does not take effect. * @@ -766,4 +846,15 @@ declare class CustomDialogController { * @since 11 */ close(); + + /** + * Closes the custom pop-up window. If the window is closed, the window does not take effect. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + close(): void; } diff --git a/api/@internal/component/ets/data_panel.d.ts b/api/@internal/component/ets/data_panel.d.ts index 02fa057c4e305c64e3a0987eadca2622188b0030..a68c0a2617af7956befb55d0df0f1db64a0fb264 100644 --- a/api/@internal/component/ets/data_panel.d.ts +++ b/api/@internal/component/ets/data_panel.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor, Length } from './units' +import { CommonMethod, ContentModifier, CommonConfiguration, MultiShadowOptions } from './common' +/*** endif */ + /** * DataPanelType enum * @@ -50,7 +55,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DataPanelType { /** @@ -81,7 +87,8 @@ declare enum DataPanelType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Line, @@ -113,7 +120,8 @@ declare enum DataPanelType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Circle, } @@ -130,7 +138,8 @@ declare enum DataPanelType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ColorStop { /** @@ -146,7 +155,8 @@ declare interface ColorStop { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color: ResourceColor; @@ -163,7 +173,8 @@ declare interface ColorStop { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset: Length; } @@ -181,7 +192,8 @@ declare interface ColorStop { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LinearGradient { /** @@ -199,7 +211,8 @@ declare class LinearGradient { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(colorStops: ColorStop[]); } @@ -221,7 +234,8 @@ declare class LinearGradient { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DataPanelShadowOptions extends MultiShadowOptions { /** @@ -241,7 +255,8 @@ declare interface DataPanelShadowOptions extends MultiShadowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ colors?: Array; } @@ -278,7 +293,8 @@ declare interface DataPanelShadowOptions extends MultiShadowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DataPanelOptions { /** @@ -313,7 +329,8 @@ declare interface DataPanelOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ values: number[]; @@ -349,7 +366,8 @@ declare interface DataPanelOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ max?: number; @@ -385,7 +403,8 @@ declare interface DataPanelOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type?: DataPanelType; } @@ -422,7 +441,8 @@ declare interface DataPanelOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface DataPanelInterface { /** @@ -461,7 +481,8 @@ interface DataPanelInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options: DataPanelOptions): DataPanelAttribute; } @@ -474,7 +495,8 @@ interface DataPanelInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DataPanelConfiguration extends CommonConfiguration { /** @@ -484,7 +506,8 @@ declare interface DataPanelConfiguration extends CommonConfiguration { /** @@ -571,7 +596,8 @@ declare class DataPanelAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ closeEffect(value: boolean): DataPanelAttribute; @@ -592,7 +618,8 @@ declare class DataPanelAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ valueColors(value: Array): DataPanelAttribute; @@ -613,7 +640,8 @@ declare class DataPanelAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ trackBackgroundColor(value: ResourceColor): DataPanelAttribute; @@ -634,7 +662,8 @@ declare class DataPanelAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth(value: Length): DataPanelAttribute; @@ -655,7 +684,8 @@ declare class DataPanelAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ trackShadow(value: DataPanelShadowOptions): DataPanelAttribute; @@ -667,7 +697,8 @@ declare class DataPanelAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): DataPanelAttribute; } diff --git a/api/@internal/component/ets/date_picker.d.ts b/api/@internal/component/ets/date_picker.d.ts index b6de0092d21dcddb303c211af8854ca2bfc0254e..8a6b42d3ddd545486a0060084b91c3d6d63de910 100644 --- a/api/@internal/component/ets/date_picker.d.ts +++ b/api/@internal/component/ets/date_picker.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, PickerTextStyle, PickerDialogButtonStyle, Rectangle, Callback, BlurStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, BackgroundBlurStyleOptions, BackgroundEffectOptions, Optional, DateTimeOptions } from './common' +import { ResourceColor, Offset, VoidCallback } from './units' +import { DialogAlignment } from './alertDialog' +import { CrownSensitivity } from './enums' +/*** endif */ + /** * Defines the struct of DatePickerResult. * @@ -40,7 +47,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DatePickerResult { /** @@ -65,7 +73,8 @@ declare interface DatePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ year?: number; @@ -91,7 +100,8 @@ declare interface DatePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ month?: number; @@ -117,7 +127,8 @@ declare interface DatePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ day?: number; } @@ -129,7 +140,8 @@ declare interface DatePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DatePickerMode { /** @@ -138,7 +150,8 @@ declare enum DatePickerMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DATE = 0, @@ -148,7 +161,8 @@ declare enum DatePickerMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ YEAR_AND_MONTH = 1, @@ -158,7 +172,8 @@ declare enum DatePickerMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MONTH_AND_DAY = 2, } @@ -185,7 +200,8 @@ declare enum DatePickerMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DatePickerOptions { /** @@ -210,7 +226,8 @@ declare interface DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ start?: Date; @@ -236,7 +253,8 @@ declare interface DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ end?: Date; @@ -262,7 +280,8 @@ declare interface DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selected?: Date; @@ -273,7 +292,8 @@ declare interface DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ mode?: DatePickerMode; } @@ -300,7 +320,8 @@ declare interface DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface DatePickerInterface { /** @@ -328,7 +349,8 @@ interface DatePickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: DatePickerOptions): DatePickerAttribute; } @@ -355,7 +377,8 @@ interface DatePickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DatePickerAttribute extends CommonMethod { /** @@ -383,7 +406,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lunar(value: boolean): DatePickerAttribute; @@ -395,7 +419,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ lunar(isLunar: Optional): DatePickerAttribute; @@ -416,7 +441,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle(value: PickerTextStyle): DatePickerAttribute; @@ -428,7 +454,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle(style: Optional): DatePickerAttribute; @@ -449,7 +476,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle(value: PickerTextStyle): DatePickerAttribute; @@ -461,7 +489,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle(style: Optional): DatePickerAttribute; @@ -482,7 +511,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle(value: PickerTextStyle): DatePickerAttribute; @@ -494,7 +524,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle(style: Optional): DatePickerAttribute; @@ -531,13 +562,15 @@ declare class DatePickerAttribute extends CommonMethod { */ /** * This event is triggered when a DatePicker date or time is selected. + * Anonymous Object Rectification. * * @param { Callback } callback * @returns { DatePickerAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDateChange(callback: Callback): DatePickerAttribute; @@ -549,7 +582,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDateChange(callback: Optional>): DatePickerAttribute; @@ -561,7 +595,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ digitalCrownSensitivity(sensitivity: Optional): DatePickerAttribute; @@ -572,7 +607,8 @@ declare class DatePickerAttribute extends CommonMethod { * @returns { DatePickerAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(enable: Optional): DatePickerAttribute; } @@ -584,7 +620,8 @@ declare class DatePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LunarSwitchStyle { /** @@ -594,7 +631,8 @@ declare interface LunarSwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor?: ResourceColor; @@ -605,7 +643,8 @@ declare interface LunarSwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ unselectedColor?: ResourceColor; @@ -616,7 +655,8 @@ declare interface LunarSwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ strokeColor?: ResourceColor; } @@ -646,7 +686,8 @@ declare interface LunarSwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DatePickerDialogOptions extends DatePickerOptions { /** @@ -671,7 +712,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lunar?: boolean; @@ -690,7 +732,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lunarSwitch?: boolean; @@ -701,7 +744,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ lunarSwitchStyle?: LunarSwitchStyle; @@ -720,7 +764,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showTime?: boolean; @@ -739,7 +784,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ useMilitaryTime?: boolean; @@ -758,7 +804,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle?: PickerTextStyle; @@ -777,7 +824,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle?: PickerTextStyle; @@ -788,7 +836,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ acceptButtonStyle?: PickerDialogButtonStyle; @@ -799,7 +848,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cancelButtonStyle?: PickerDialogButtonStyle; @@ -818,7 +868,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle?: PickerTextStyle; @@ -837,7 +888,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskRect?: Rectangle; @@ -856,7 +908,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: DialogAlignment; @@ -875,7 +928,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Offset; @@ -916,12 +970,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Called when the Cancel button in the dialog is clicked. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onCancel?: VoidCallback; @@ -955,12 +1011,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Called when the OK button in the dialog is clicked. + * Anonymous Object Rectification. * * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDateAccept?: Callback; @@ -983,12 +1041,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * This event is triggered when a DatePicker date or time is selected in dialog. + * Anonymous Object Rectification. * * @type { ?Callback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDateChange?: Callback; @@ -1009,7 +1069,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -1030,7 +1091,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -1041,7 +1103,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -1052,7 +1115,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -1067,12 +1131,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function when the dialog appears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: VoidCallback; @@ -1087,12 +1153,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function when the dialog disappears. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: VoidCallback; @@ -1107,12 +1175,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function before the dialog openAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: VoidCallback; @@ -1127,12 +1197,14 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { */ /** * Callback function before the dialog closeAnimation starts. + * Anonymous Object Rectification. * * @type { ?VoidCallback } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: VoidCallback; @@ -1143,7 +1215,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -1154,7 +1227,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dateTimeOptions?: DateTimeOptions; @@ -1166,7 +1240,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -1178,7 +1253,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -1189,7 +1265,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback?: boolean; } @@ -1213,7 +1290,8 @@ declare interface DatePickerDialogOptions extends DatePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DatePickerDialog { /** diff --git a/api/@internal/component/ets/divider.d.ts b/api/@internal/component/ets/divider.d.ts index 2ee8f0971bbda0b25ebc343538ec63643465cef9..8bb25614340f5bb5c60584051d70b11885e1e0da 100644 --- a/api/@internal/component/ets/divider.d.ts +++ b/api/@internal/component/ets/divider.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor } from './units'; +import { CommonMethod} from './common'; +import { LineCapStyle } from './enums'; +/*** endif */ + /** * Provides a divider component to separate different content blocks/content elements. * @@ -50,7 +56,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface DividerInterface { /** @@ -85,7 +92,8 @@ interface DividerInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): DividerAttribute; } @@ -122,7 +130,8 @@ interface DividerInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DividerAttribute extends CommonMethod { /** @@ -165,7 +174,8 @@ declare class DividerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ vertical(value: boolean): DividerAttribute; @@ -205,7 +215,8 @@ declare class DividerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color(value: ResourceColor): DividerAttribute; @@ -245,7 +256,8 @@ declare class DividerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth(value: number | string): DividerAttribute; @@ -285,7 +297,8 @@ declare class DividerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lineCap(value: LineCapStyle): DividerAttribute; } diff --git a/api/@internal/component/ets/effect_component.d.ts b/api/@internal/component/ets/effect_component.d.ts index daf057f9b93cae4abaac37721287a07ada7c1a65..984d0689c8f99f0d4f6da02b1892bf15d7b9b614 100644 --- a/api/@internal/component/ets/effect_component.d.ts +++ b/api/@internal/component/ets/effect_component.d.ts @@ -17,7 +17,10 @@ * @file * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod} from './common'; +/*** endif */ /** * Provides an Effect Component, which is invisible, but setting properties on this component defines an effect template * that child components can apply by setting useEffect(true). @@ -25,7 +28,8 @@ * @interface EffectComponentInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface EffectComponentInterface { /** @@ -34,7 +38,8 @@ interface EffectComponentInterface { * @returns { EffectComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ (): EffectComponentAttribute; } @@ -45,7 +50,8 @@ interface EffectComponentInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class EffectComponentAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/ellipse.d.ts b/api/@internal/component/ets/ellipse.d.ts index f2c2fde0182f9e1ac85da1bb66c9935e7e474a09..b1a62cc395a5e816de64e4ddb9315309100cf0c5 100644 --- a/api/@internal/component/ets/ellipse.d.ts +++ b/api/@internal/component/ets/ellipse.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonShapeMethod } from './common'; +/*** endif */ + /** * Ellipse constructor options. * @@ -26,7 +30,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface EllipseOptions { /** @@ -61,7 +66,8 @@ interface EllipseOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: string | number; @@ -97,7 +103,8 @@ interface EllipseOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: string | number; } @@ -264,7 +271,8 @@ interface EllipseInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class EllipseAttribute extends CommonShapeMethod {} @@ -331,3 +339,30 @@ declare const Ellipse: EllipseInterface; * @since 11 */ declare const EllipseInstance: EllipseAttribute; + +/** + * Ellipse drawing. + * + * @interface EllipseInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface EllipseInterface { + /** + * Set the value. + * + * @param { EllipseOptions } [options] - ellipse options + * @returns { EllipseAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options?: EllipseOptions): EllipseAttribute; +} diff --git a/api/@internal/component/ets/embedded_component.d.ts b/api/@internal/component/ets/embedded_component.d.ts index 48a15bb05a5d230625ea2f63cf15ec9e075a4af1..618d27c366c1c4ee72723a0401bb2601fc090dfd 100644 --- a/api/@internal/component/ets/embedded_component.d.ts +++ b/api/@internal/component/ets/embedded_component.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import Want from '../../@ohos.app.ability.Want' +import { Callback, ErrorCallback ,BusinessError} from '../../@ohos.base' +import { CommonMethod } from './common' +import { EmbeddedType } from './enums' +/*** endif */ /** * Provide an interface for the EmbeddedComponent, which is used @@ -26,7 +32,8 @@ * @interface EmbeddedComponentInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface EmbeddedComponentInterface { /** @@ -44,6 +51,23 @@ interface EmbeddedComponentInterface { loader: import('../api/@ohos.app.ability.Want').default, type: EmbeddedType ): EmbeddedComponentAttribute; + + /** + * Construct the EmbeddedComponent.
+ * Called when the EmbeddedComponent is used. + * + * @param { Want } loader - indicates initialization parameter + * @param { EmbeddedType } type - indicates type of the EmbeddedComponent + * @returns { EmbeddedComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + ( + loader: Want, + type: EmbeddedType + ): EmbeddedComponentAttribute; } /** @@ -76,13 +100,44 @@ declare interface TerminationInfo { want?: import('../api/@ohos.app.ability.Want').default; } +/** + * Indicates the information when the provider of the embedded UI is terminated. + * + * @interface TerminationInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + * @arkts 1.2 + */ +declare interface TerminationInfo { + /** + * Defines the termination code. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + * @arkts 1.2 + */ + code: number; + + /** + * Defines the additional termination information. + * + * @type { ?Want } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 20 + * @arkts 1.2 + */ + want?: Want; +} + /** * Define the attribute functions of EmbeddedComponent. * * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class EmbeddedComponentAttribute extends CommonMethod { /** @@ -95,6 +150,18 @@ declare class EmbeddedComponentAttribute extends CommonMethod): EmbeddedComponentAttribute; + + /** + * Called when the provider of the embedded UI is terminated. + * + * @param { Callback } callback + * @returns { EmbeddedComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onTerminated(callback: Callback): EmbeddedComponentAttribute; /** * Called when some error occurred. @@ -106,6 +173,18 @@ declare class EmbeddedComponentAttribute extends CommonMethod): EmbeddedComponentAttribute; } /** diff --git a/api/@internal/component/ets/enums.d.ts b/api/@internal/component/ets/enums.d.ts index 33f2c2cd3ed48bcba1cf0d5ad514a93c13101beb..9b7534ff631c9aae4589e2a19f48f30219bdd9ce 100644 --- a/api/@internal/component/ets/enums.d.ts +++ b/api/@internal/component/ets/enums.d.ts @@ -35,7 +35,8 @@ * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CheckBoxShape { /** @@ -53,7 +54,8 @@ declare enum CheckBoxShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CIRCLE = 0, @@ -72,7 +74,8 @@ declare enum CheckBoxShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROUNDED_SQUARE = 1, } @@ -109,7 +112,8 @@ declare enum CheckBoxShape { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Color { /** @@ -140,7 +144,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ White, @@ -172,7 +177,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Black, @@ -204,7 +210,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Blue, @@ -236,7 +243,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Brown, @@ -268,7 +276,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Gray, @@ -300,7 +309,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Green, @@ -332,7 +342,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Grey, @@ -364,7 +375,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Orange, @@ -396,7 +408,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Pink, @@ -428,7 +441,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Red, @@ -460,7 +474,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Yellow, @@ -486,7 +501,8 @@ declare enum Color { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Transparent, } @@ -506,7 +522,8 @@ declare enum Color { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ColoringStrategy { /** @@ -522,7 +539,8 @@ declare enum ColoringStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ INVERT = 'invert', @@ -539,7 +557,8 @@ declare enum ColoringStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AVERAGE = 'average', @@ -556,7 +575,8 @@ declare enum ColoringStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIMARY = 'primary', } @@ -593,7 +613,8 @@ declare enum ColoringStrategy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageFit { /** @@ -624,7 +645,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Contain, @@ -656,7 +678,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Cover, @@ -688,7 +711,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, @@ -720,7 +744,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Fill, @@ -752,7 +777,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ScaleDown, @@ -784,7 +810,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -795,7 +822,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP_START = 7, @@ -806,7 +834,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP = 8, @@ -817,7 +846,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP_END = 9, @@ -828,7 +858,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START = 10, @@ -839,7 +870,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 11, @@ -850,7 +882,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END = 12, @@ -861,7 +894,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM_START = 13, @@ -872,7 +906,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM = 14, @@ -883,7 +918,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM_END = 15, @@ -893,7 +929,8 @@ declare enum ImageFit { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ MATRIX = 16, } @@ -930,7 +967,8 @@ declare enum ImageFit { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BorderStyle { /** @@ -961,7 +999,8 @@ declare enum BorderStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Dotted, @@ -993,7 +1032,8 @@ declare enum BorderStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Dashed, @@ -1025,7 +1065,8 @@ declare enum BorderStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Solid, } @@ -1062,7 +1103,8 @@ declare enum BorderStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LineJoinStyle { /** @@ -1093,7 +1135,8 @@ declare enum LineJoinStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Miter, @@ -1125,7 +1168,8 @@ declare enum LineJoinStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Round, @@ -1157,7 +1201,8 @@ declare enum LineJoinStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bevel, } @@ -1184,7 +1229,8 @@ declare enum LineJoinStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TouchType { /** @@ -1206,7 +1252,8 @@ declare enum TouchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Down, @@ -1229,7 +1276,8 @@ declare enum TouchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Up, @@ -1252,7 +1300,8 @@ declare enum TouchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Move, @@ -1275,7 +1324,8 @@ declare enum TouchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Cancel, } @@ -1287,7 +1337,8 @@ declare enum TouchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum InteractionHand { /** @@ -1296,7 +1347,8 @@ declare enum InteractionHand { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -1306,7 +1358,8 @@ declare enum InteractionHand { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ LEFT = 1, @@ -1316,7 +1369,8 @@ declare enum InteractionHand { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT = 2, } @@ -1343,7 +1397,8 @@ declare enum InteractionHand { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MouseButton { /** @@ -1365,7 +1420,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, @@ -1388,7 +1444,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -1411,7 +1468,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Middle, @@ -1434,7 +1492,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Back, @@ -1457,7 +1516,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Forward, @@ -1480,7 +1540,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -1507,7 +1568,8 @@ declare enum MouseButton { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MouseAction { /** @@ -1529,7 +1591,8 @@ declare enum MouseAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Press, @@ -1552,7 +1615,8 @@ declare enum MouseAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Release, @@ -1575,7 +1639,8 @@ declare enum MouseAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Move, @@ -1598,7 +1663,8 @@ declare enum MouseAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Hover, @@ -1607,7 +1673,8 @@ declare enum MouseAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 13 } @@ -1636,7 +1703,8 @@ declare enum MouseAction { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AnimationStatus { /** @@ -1660,7 +1728,8 @@ declare enum AnimationStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Initial, @@ -1685,7 +1754,8 @@ declare enum AnimationStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Running, @@ -1710,7 +1780,8 @@ declare enum AnimationStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Paused, @@ -1735,7 +1806,8 @@ declare enum AnimationStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Stopped, } @@ -1772,7 +1844,8 @@ declare enum AnimationStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Curve { /** @@ -1803,7 +1876,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Linear, @@ -1835,7 +1909,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Ease, @@ -1867,7 +1942,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EaseIn, @@ -1899,7 +1975,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EaseOut, @@ -1931,7 +2008,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EaseInOut, @@ -1963,7 +2041,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FastOutSlowIn, @@ -1995,7 +2074,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LinearOutSlowIn, @@ -2027,7 +2107,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FastOutLinearIn, @@ -2059,7 +2140,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ExtremeDeceleration, @@ -2091,7 +2173,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Sharp, @@ -2123,7 +2206,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Rhythm, @@ -2155,7 +2239,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Smooth, @@ -2187,7 +2272,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Friction, } @@ -2216,7 +2302,8 @@ declare enum Curve { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FillMode { /** @@ -2240,7 +2327,8 @@ declare enum FillMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -2265,7 +2353,8 @@ declare enum FillMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Forwards, @@ -2290,7 +2379,8 @@ declare enum FillMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Backwards, @@ -2315,7 +2405,8 @@ declare enum FillMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Both, } @@ -2352,7 +2443,8 @@ declare enum FillMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PlayMode { /** @@ -2383,7 +2475,8 @@ declare enum PlayMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -2415,7 +2508,8 @@ declare enum PlayMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Reverse, @@ -2447,7 +2541,8 @@ declare enum PlayMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Alternate, @@ -2479,7 +2574,8 @@ declare enum PlayMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AlternateReverse, } @@ -2506,7 +2602,8 @@ declare enum PlayMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum KeyType { /** @@ -2528,7 +2625,8 @@ declare enum KeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Down, @@ -2551,7 +2649,8 @@ declare enum KeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Up, } @@ -2578,7 +2677,8 @@ declare enum KeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum KeySource { /** @@ -2600,7 +2700,8 @@ declare enum KeySource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Unknown, @@ -2623,7 +2724,8 @@ declare enum KeySource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Keyboard, @@ -2633,7 +2735,8 @@ declare enum KeySource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ JOYSTICK, } @@ -2660,7 +2763,8 @@ declare enum KeySource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Edge { /** @@ -2682,7 +2786,8 @@ declare enum Edge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -2714,7 +2819,8 @@ declare enum Edge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, @@ -2746,7 +2852,8 @@ declare enum Edge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -2778,7 +2885,8 @@ declare enum Edge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, } @@ -2805,7 +2913,8 @@ declare enum Edge { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Week { /** @@ -2827,7 +2936,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Mon, @@ -2850,7 +2960,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Tue, @@ -2873,7 +2984,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Wed, @@ -2896,7 +3008,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Thur, @@ -2919,7 +3032,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Fri, @@ -2942,7 +3056,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Sat, @@ -2965,7 +3080,8 @@ declare enum Week { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Sun, } @@ -3002,7 +3118,8 @@ declare enum Week { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Direction { /** @@ -3033,7 +3150,8 @@ declare enum Direction { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Ltr, @@ -3065,7 +3183,8 @@ declare enum Direction { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Rtl, @@ -3097,7 +3216,8 @@ declare enum Direction { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, } @@ -3134,7 +3254,8 @@ declare enum Direction { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BarState { /** @@ -3165,7 +3286,8 @@ declare enum BarState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Off, @@ -3197,7 +3319,8 @@ declare enum BarState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, @@ -3229,7 +3352,8 @@ declare enum BarState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ On, } @@ -3266,7 +3390,8 @@ declare enum BarState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EdgeEffect { /** @@ -3297,7 +3422,8 @@ declare enum EdgeEffect { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Spring, @@ -3329,7 +3455,8 @@ declare enum EdgeEffect { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Fade, @@ -3361,7 +3488,8 @@ declare enum EdgeEffect { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -3398,7 +3526,8 @@ declare enum EdgeEffect { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Alignment { /** @@ -3429,7 +3558,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TopStart, @@ -3461,7 +3591,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -3493,7 +3624,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TopEnd, @@ -3525,7 +3657,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -3557,7 +3690,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -3589,7 +3723,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, @@ -3621,7 +3756,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BottomStart, @@ -3653,7 +3789,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, @@ -3685,7 +3822,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BottomEnd, } @@ -3722,7 +3860,8 @@ declare enum Alignment { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TransitionType { /** @@ -3753,7 +3892,8 @@ declare enum TransitionType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ All, @@ -3785,7 +3925,8 @@ declare enum TransitionType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Insert, @@ -3817,7 +3958,8 @@ declare enum TransitionType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Delete, } @@ -3844,7 +3986,8 @@ declare enum TransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RelateType { /** @@ -3866,7 +4009,8 @@ declare enum RelateType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FILL, @@ -3889,7 +4033,8 @@ declare enum RelateType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FIT, } @@ -3926,7 +4071,8 @@ declare enum RelateType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Visibility { /** @@ -3957,7 +4103,8 @@ declare enum Visibility { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Visible, @@ -3989,7 +4136,8 @@ declare enum Visibility { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Hidden, @@ -4021,7 +4169,8 @@ declare enum Visibility { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -4058,7 +4207,8 @@ declare enum Visibility { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LineCapStyle { /** @@ -4089,7 +4239,8 @@ declare enum LineCapStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Butt, @@ -4121,7 +4272,8 @@ declare enum LineCapStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Round, @@ -4153,7 +4305,8 @@ declare enum LineCapStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Square, } @@ -4190,7 +4343,8 @@ declare enum LineCapStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Axis { /** @@ -4221,7 +4375,8 @@ declare enum Axis { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Vertical, @@ -4253,7 +4408,8 @@ declare enum Axis { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Horizontal, } @@ -4290,7 +4446,8 @@ declare enum Axis { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HorizontalAlign { /** @@ -4321,7 +4478,8 @@ declare enum HorizontalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -4353,7 +4511,8 @@ declare enum HorizontalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -4385,7 +4544,8 @@ declare enum HorizontalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, } @@ -4422,7 +4582,8 @@ declare enum HorizontalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FlexAlign { /** @@ -4457,7 +4618,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -4493,7 +4655,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -4529,7 +4692,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, @@ -4569,7 +4733,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SpaceBetween, @@ -4609,7 +4774,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SpaceAround, @@ -4649,7 +4815,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SpaceEvenly, } @@ -4686,7 +4853,8 @@ declare enum FlexAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ItemAlign { /** @@ -4717,7 +4885,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, @@ -4749,7 +4918,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -4781,7 +4951,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -4813,7 +4984,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, @@ -4845,7 +5017,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Baseline, @@ -4877,7 +5050,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Stretch, } @@ -4914,7 +5088,8 @@ declare enum ItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FlexDirection { /** @@ -4945,7 +5120,8 @@ declare enum FlexDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Row, @@ -4977,7 +5153,8 @@ declare enum FlexDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Column, @@ -5009,7 +5186,8 @@ declare enum FlexDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RowReverse, @@ -5041,7 +5219,8 @@ declare enum FlexDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ColumnReverse, } @@ -5054,7 +5233,8 @@ declare enum FlexDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PixelRoundCalcPolicy { /** @@ -5064,7 +5244,8 @@ declare enum PixelRoundCalcPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NO_FORCE_ROUND = 0, /** @@ -5074,7 +5255,8 @@ declare enum PixelRoundCalcPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FORCE_CEIL = 1, /** @@ -5084,7 +5266,8 @@ declare enum PixelRoundCalcPolicy { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FORCE_FLOOR = 2, } @@ -5097,7 +5280,8 @@ declare enum PixelRoundCalcPolicy { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PixelRoundMode { /** @@ -5107,7 +5291,8 @@ declare enum PixelRoundMode { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PIXEL_ROUND_ON_LAYOUT_FINISH = 0, /** @@ -5117,7 +5302,8 @@ declare enum PixelRoundMode { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PIXEL_ROUND_AFTER_MEASURE = 1, } @@ -5154,7 +5340,8 @@ declare enum PixelRoundMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FlexWrap { /** @@ -5185,7 +5372,8 @@ declare enum FlexWrap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NoWrap, @@ -5217,7 +5405,8 @@ declare enum FlexWrap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Wrap, @@ -5249,7 +5438,8 @@ declare enum FlexWrap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ WrapReverse, } @@ -5286,7 +5476,8 @@ declare enum FlexWrap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum VerticalAlign { /** @@ -5317,7 +5508,8 @@ declare enum VerticalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -5349,7 +5541,8 @@ declare enum VerticalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -5381,7 +5574,8 @@ declare enum VerticalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, } @@ -5418,7 +5612,8 @@ declare enum VerticalAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageRepeat { /** @@ -5449,7 +5644,8 @@ declare enum ImageRepeat { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NoRepeat, @@ -5481,7 +5677,8 @@ declare enum ImageRepeat { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ X, @@ -5513,7 +5710,8 @@ declare enum ImageRepeat { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Y, @@ -5545,7 +5743,8 @@ declare enum ImageRepeat { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ XY, } @@ -5582,7 +5781,8 @@ declare enum ImageRepeat { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageSize { /** @@ -5613,7 +5813,8 @@ declare enum ImageSize { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, @@ -5645,7 +5846,8 @@ declare enum ImageSize { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Cover, @@ -5677,7 +5879,8 @@ declare enum ImageSize { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Contain, @@ -5687,7 +5890,8 @@ declare enum ImageSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FILL = 3, } @@ -5724,7 +5928,8 @@ declare enum ImageSize { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GradientDirection { /** @@ -5755,7 +5960,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, @@ -5787,7 +5993,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -5819,7 +6026,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -5851,7 +6059,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, @@ -5883,7 +6092,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LeftTop, @@ -5915,7 +6125,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LeftBottom, @@ -5947,7 +6158,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RightTop, @@ -5979,7 +6191,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RightBottom, @@ -6011,7 +6224,8 @@ declare enum GradientDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -6038,7 +6252,8 @@ declare enum GradientDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SharedTransitionEffectType { /** @@ -6063,7 +6278,8 @@ declare enum SharedTransitionEffectType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Static, @@ -6086,7 +6302,8 @@ declare enum SharedTransitionEffectType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Exchange, } @@ -6123,7 +6340,8 @@ declare enum SharedTransitionEffectType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FontStyle { /** @@ -6154,7 +6372,8 @@ declare enum FontStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -6186,7 +6405,8 @@ declare enum FontStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Italic, } @@ -6223,7 +6443,8 @@ declare enum FontStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FontWeight { /** @@ -6254,7 +6475,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Lighter, @@ -6286,7 +6508,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -6318,7 +6541,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Regular, @@ -6350,7 +6574,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Medium, @@ -6382,7 +6607,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bold, @@ -6414,7 +6640,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bolder, } @@ -6451,7 +6678,8 @@ declare enum FontWeight { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextAlign { /** @@ -6482,7 +6710,8 @@ declare enum TextAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -6514,7 +6743,8 @@ declare enum TextAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -6546,7 +6776,8 @@ declare enum TextAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, @@ -6565,7 +6796,8 @@ declare enum TextAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ JUSTIFY, } @@ -6602,7 +6834,8 @@ declare enum TextAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextOverflow { /** @@ -6633,7 +6866,8 @@ declare enum TextOverflow { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -6665,7 +6899,8 @@ declare enum TextOverflow { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Clip, @@ -6697,7 +6932,8 @@ declare enum TextOverflow { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Ellipsis, @@ -6714,7 +6950,8 @@ declare enum TextOverflow { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MARQUEE, } @@ -6751,7 +6988,8 @@ declare enum TextOverflow { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextDecorationType { /** @@ -6782,7 +7020,8 @@ declare enum TextDecorationType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -6814,7 +7053,8 @@ declare enum TextDecorationType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Underline, @@ -6846,7 +7086,8 @@ declare enum TextDecorationType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Overline, @@ -6878,7 +7119,8 @@ declare enum TextDecorationType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LineThrough, } @@ -6915,7 +7157,8 @@ declare enum TextDecorationType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextCase { /** @@ -6946,7 +7189,8 @@ declare enum TextCase { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -6978,7 +7222,8 @@ declare enum TextCase { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LowerCase, @@ -7010,7 +7255,8 @@ declare enum TextCase { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UpperCase, } @@ -7030,7 +7276,8 @@ declare enum TextCase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextHeightAdaptivePolicy { /** @@ -7050,7 +7297,8 @@ declare enum TextHeightAdaptivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MAX_LINES_FIRST, @@ -7071,7 +7319,8 @@ declare enum TextHeightAdaptivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MIN_FONT_SIZE_FIRST, @@ -7094,7 +7343,8 @@ declare enum TextHeightAdaptivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LAYOUT_CONSTRAINT_FIRST, } @@ -7121,7 +7371,8 @@ declare enum TextHeightAdaptivePolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ResponseType { /** @@ -7143,7 +7394,8 @@ declare enum ResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RightClick, @@ -7166,7 +7418,8 @@ declare enum ResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LongPress, } @@ -7193,7 +7446,8 @@ declare enum ResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HoverEffect { /** @@ -7215,7 +7469,8 @@ declare enum HoverEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, @@ -7238,7 +7493,8 @@ declare enum HoverEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Scale, @@ -7261,7 +7517,8 @@ declare enum HoverEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Highlight, @@ -7284,7 +7541,8 @@ declare enum HoverEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -7311,7 +7569,8 @@ declare enum HoverEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum Placement { /** @@ -7333,7 +7592,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, @@ -7356,7 +7616,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -7379,7 +7640,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -7402,7 +7664,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, @@ -7425,7 +7688,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TopLeft, @@ -7448,7 +7712,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TopRight, @@ -7471,7 +7736,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BottomLeft, @@ -7494,7 +7760,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BottomRight, @@ -7517,7 +7784,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LeftTop, @@ -7540,7 +7808,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LeftBottom, @@ -7563,7 +7832,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RightTop, @@ -7586,7 +7856,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RightBottom, } @@ -7606,7 +7877,8 @@ declare enum Placement { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ArrowPointPosition { /** @@ -7622,7 +7894,8 @@ declare enum ArrowPointPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START = 'Start', @@ -7639,7 +7912,8 @@ declare enum ArrowPointPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 'Center', @@ -7656,7 +7930,8 @@ declare enum ArrowPointPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END = 'End', } @@ -7686,7 +7961,8 @@ declare enum ArrowPointPosition { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CopyOptions { /** @@ -7711,7 +7987,8 @@ declare enum CopyOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None = 0, @@ -7737,7 +8014,8 @@ declare enum CopyOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ InApp = 1, @@ -7763,7 +8041,8 @@ declare enum CopyOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LocalDevice = 2, @@ -7801,7 +8080,8 @@ declare enum CopyOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HitTestMode { /** @@ -7826,7 +8106,8 @@ declare enum HitTestMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Default, @@ -7852,7 +8133,8 @@ declare enum HitTestMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Block, @@ -7878,7 +8160,8 @@ declare enum HitTestMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Transparent, @@ -7904,7 +8187,8 @@ declare enum HitTestMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -7931,7 +8215,8 @@ declare enum HitTestMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TitleHeight { /** @@ -7953,7 +8238,8 @@ declare enum TitleHeight { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MainOnly, @@ -7976,7 +8262,8 @@ declare enum TitleHeight { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MainWithSub, } @@ -7996,7 +8283,8 @@ declare enum TitleHeight { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ModifierKey { /** @@ -8012,7 +8300,8 @@ declare enum ModifierKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CTRL, @@ -8029,7 +8318,8 @@ declare enum ModifierKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SHIFT, @@ -8046,7 +8336,8 @@ declare enum ModifierKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ALT, } @@ -8066,7 +8357,8 @@ declare enum ModifierKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FunctionKey { /** @@ -8082,7 +8374,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ESC, @@ -8099,7 +8392,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F1, @@ -8116,7 +8410,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F2, @@ -8133,7 +8428,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F3, @@ -8150,7 +8446,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F4, @@ -8167,7 +8464,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F5, @@ -8184,7 +8482,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F6, @@ -8201,7 +8500,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F7, @@ -8218,7 +8518,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F8, @@ -8235,7 +8536,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F9, @@ -8252,7 +8554,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F10, @@ -8269,7 +8572,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F11, @@ -8286,7 +8590,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ F12, @@ -8296,7 +8601,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TAB, @@ -8306,7 +8612,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DPAD_UP, @@ -8316,7 +8623,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DPAD_DOWN, @@ -8326,7 +8634,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DPAD_LEFT, @@ -8336,7 +8645,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DPAD_RIGHT, } @@ -8356,7 +8666,8 @@ declare enum FunctionKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageSpanAlignment { /** @@ -8372,7 +8683,8 @@ declare enum ImageSpanAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BASELINE, @@ -8389,7 +8701,8 @@ declare enum ImageSpanAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM, @@ -8406,7 +8719,8 @@ declare enum ImageSpanAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER, @@ -8423,7 +8737,8 @@ declare enum ImageSpanAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TOP, } @@ -8442,7 +8757,8 @@ declare enum ImageSpanAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ObscuredReasons { /** @@ -8457,7 +8773,8 @@ declare enum ObscuredReasons { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PLACEHOLDER = 0, } @@ -8476,7 +8793,8 @@ declare enum ObscuredReasons { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextContentStyle { /** @@ -8491,7 +8809,8 @@ declare enum TextContentStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT, @@ -8507,7 +8826,8 @@ declare enum TextContentStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ INLINE } @@ -8527,7 +8847,8 @@ declare enum TextContentStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ClickEffectLevel { /** @@ -8547,7 +8868,8 @@ declare enum ClickEffectLevel { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHT, @@ -8568,7 +8890,8 @@ declare enum ClickEffectLevel { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE, @@ -8589,7 +8912,8 @@ declare enum ClickEffectLevel { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HEAVY, } @@ -8616,7 +8940,8 @@ declare enum ClickEffectLevel { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum XComponentType { /** @@ -8638,7 +8963,8 @@ declare enum XComponentType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SURFACE, @@ -8669,7 +8995,8 @@ declare enum XComponentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TEXTURE, @@ -8678,7 +9005,8 @@ declare enum XComponentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NODE, } @@ -8697,7 +9025,8 @@ declare enum XComponentType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NestedScrollMode { /** @@ -8712,7 +9041,8 @@ declare enum NestedScrollMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SELF_ONLY, @@ -8728,7 +9058,8 @@ declare enum NestedScrollMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SELF_FIRST, @@ -8744,7 +9075,8 @@ declare enum NestedScrollMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PARENT_FIRST, @@ -8760,7 +9092,8 @@ declare enum NestedScrollMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PARALLEL, } @@ -8771,7 +9104,8 @@ declare enum NestedScrollMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollSource { /** @@ -8779,7 +9113,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DRAG = 0, @@ -8788,7 +9123,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FLING, @@ -8797,7 +9133,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EDGE_EFFECT, @@ -8806,7 +9143,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OTHER_USER_INPUT, @@ -8815,7 +9153,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_BAR, @@ -8824,7 +9163,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_BAR_FLING, @@ -8833,7 +9173,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLLER, @@ -8842,7 +9183,8 @@ declare enum ScrollSource { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLLER_ANIMATION, } @@ -8872,7 +9214,8 @@ declare enum ScrollSource { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RenderFit { /** @@ -8897,7 +9240,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 0, /** @@ -8922,7 +9266,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TOP = 1, /** @@ -8947,7 +9292,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM = 2, /** @@ -8972,7 +9318,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LEFT = 3, /** @@ -8997,7 +9344,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT = 4, /** @@ -9022,7 +9370,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TOP_LEFT = 5, /** @@ -9047,7 +9396,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TOP_RIGHT = 6, /** @@ -9072,7 +9422,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM_LEFT = 7, /** @@ -9097,7 +9448,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM_RIGHT = 8, /** @@ -9122,7 +9474,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_FILL = 9, /** @@ -9153,7 +9506,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_CONTAIN = 10, /** @@ -9190,7 +9544,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_CONTAIN_TOP_LEFT = 11, /** @@ -9227,7 +9582,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_CONTAIN_BOTTOM_RIGHT = 12, /** @@ -9258,7 +9614,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_COVER = 13, /** @@ -9295,7 +9652,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_COVER_TOP_LEFT = 14, /** @@ -9332,7 +9690,8 @@ declare enum RenderFit { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_COVER_BOTTOM_RIGHT = 15, } @@ -9350,7 +9709,8 @@ declare enum RenderFit { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DialogButtonStyle { /** @@ -9364,7 +9724,8 @@ declare enum DialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -9379,7 +9740,8 @@ declare enum DialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HIGHLIGHT = 1 } @@ -9391,7 +9753,8 @@ declare enum DialogButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WordBreak { /** @@ -9400,7 +9763,8 @@ declare enum WordBreak { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, @@ -9410,7 +9774,8 @@ declare enum WordBreak { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BREAK_ALL = 1, @@ -9421,7 +9786,8 @@ declare enum WordBreak { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BREAK_WORD = 2, @@ -9431,7 +9797,8 @@ declare enum WordBreak { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ HYPHENATION = 3, } @@ -9443,7 +9810,8 @@ declare enum WordBreak { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LineBreakStrategy { /** @@ -9453,7 +9821,8 @@ declare enum LineBreakStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GREEDY = 0, @@ -9464,7 +9833,8 @@ declare enum LineBreakStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH_QUALITY = 1, @@ -9475,7 +9845,8 @@ declare enum LineBreakStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BALANCED = 2, } @@ -9486,7 +9857,8 @@ declare enum LineBreakStrategy { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum IlluminatedType { /** @@ -9494,7 +9866,8 @@ declare enum IlluminatedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, /** @@ -9502,7 +9875,8 @@ declare enum IlluminatedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BORDER = 1, /** @@ -9510,7 +9884,8 @@ declare enum IlluminatedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT = 2, /** @@ -9518,7 +9893,8 @@ declare enum IlluminatedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BORDER_CONTENT = 3, /** @@ -9526,7 +9902,8 @@ declare enum IlluminatedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BLOOM_BORDER = 4, /** @@ -9534,7 +9911,8 @@ declare enum IlluminatedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BLOOM_BORDER_CONTENT = 5 } @@ -9554,7 +9932,8 @@ declare enum IlluminatedType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EllipsisMode { /** @@ -9570,7 +9949,8 @@ declare enum EllipsisMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START = 0, @@ -9587,7 +9967,8 @@ declare enum EllipsisMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 1, @@ -9604,7 +9985,8 @@ declare enum EllipsisMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END = 2, } @@ -9624,7 +10006,8 @@ declare enum EllipsisMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type Nullable = T | undefined; @@ -9644,7 +10027,8 @@ declare type Nullable = T | undefined; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum OptionWidthMode { /** @@ -9660,7 +10044,8 @@ declare enum OptionWidthMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FIT_CONTENT = 'fit_content', @@ -9677,7 +10062,8 @@ declare enum OptionWidthMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FIT_TRIGGER = 'fit_trigger', } @@ -9697,7 +10083,8 @@ declare enum OptionWidthMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FoldStatus { /** @@ -9713,7 +10100,8 @@ declare enum FoldStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_UNKNOWN = 0, /** @@ -9729,7 +10117,8 @@ declare enum FoldStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_EXPANDED = 1, /** @@ -9745,7 +10134,8 @@ declare enum FoldStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_FOLDED = 2, /** @@ -9761,7 +10151,8 @@ declare enum FoldStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_HALF_FOLDED = 3, } @@ -9772,7 +10163,8 @@ declare enum FoldStatus { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AppRotation { @@ -9781,7 +10173,8 @@ declare enum AppRotation { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_0 = 0, @@ -9790,7 +10183,8 @@ declare enum AppRotation { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_90 = 1, @@ -9799,7 +10193,8 @@ declare enum AppRotation { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_180 = 2, @@ -9808,7 +10203,8 @@ declare enum AppRotation { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_270 = 3 } @@ -9819,7 +10215,8 @@ declare enum AppRotation { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EmbeddedType { /** @@ -9827,7 +10224,8 @@ declare enum EmbeddedType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED_UI_EXTENSION = 0, } @@ -9839,7 +10237,8 @@ declare enum EmbeddedType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MarqueeUpdateStrategy { /** @@ -9848,7 +10247,8 @@ declare enum MarqueeUpdateStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -9858,7 +10258,8 @@ declare enum MarqueeUpdateStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRESERVE_POSITION = 1 } @@ -9870,7 +10271,8 @@ declare enum MarqueeUpdateStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextDecorationStyle { /** @@ -9879,7 +10281,8 @@ declare enum TextDecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOLID = 0, @@ -9889,7 +10292,8 @@ declare enum TextDecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOUBLE = 1, @@ -9899,7 +10303,8 @@ declare enum TextDecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOTTED = 2, @@ -9909,7 +10314,8 @@ declare enum TextDecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DASHED = 3, @@ -9919,7 +10325,8 @@ declare enum TextDecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WAVY = 4, } @@ -9931,7 +10338,8 @@ declare enum TextDecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextSelectableMode { /** @@ -9940,7 +10348,8 @@ declare enum TextSelectableMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SELECTABLE_UNFOCUSABLE = 0, @@ -9950,7 +10359,8 @@ declare enum TextSelectableMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SELECTABLE_FOCUSABLE = 1, @@ -9960,7 +10370,8 @@ declare enum TextSelectableMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UNSELECTABLE = 2, } @@ -9972,7 +10383,8 @@ declare enum TextSelectableMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AccessibilityHoverType { /** @@ -9981,7 +10393,8 @@ declare enum AccessibilityHoverType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HOVER_ENTER = 0, @@ -9991,7 +10404,8 @@ declare enum AccessibilityHoverType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HOVER_MOVE = 1, @@ -10001,7 +10415,8 @@ declare enum AccessibilityHoverType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HOVER_EXIT = 2, @@ -10011,7 +10426,8 @@ declare enum AccessibilityHoverType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HOVER_CANCEL = 3, } @@ -10022,7 +10438,8 @@ declare enum AccessibilityHoverType { * @enum {number} * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WidthBreakpoint { /** @@ -10030,7 +10447,8 @@ declare enum WidthBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH_XS = 0, @@ -10039,7 +10457,8 @@ declare enum WidthBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH_SM = 1, @@ -10048,7 +10467,8 @@ declare enum WidthBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH_MD = 2, @@ -10057,7 +10477,8 @@ declare enum WidthBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH_LG = 3, @@ -10066,7 +10487,8 @@ declare enum WidthBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH_XL = 4, } @@ -10077,7 +10499,8 @@ declare enum WidthBreakpoint { * @enum {number} * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HeightBreakpoint { /** @@ -10085,7 +10508,8 @@ declare enum HeightBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ HEIGHT_SM = 0, @@ -10094,7 +10518,8 @@ declare enum HeightBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ HEIGHT_MD = 1, @@ -10103,7 +10528,8 @@ declare enum HeightBreakpoint { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ HEIGHT_LG = 2, } @@ -10114,7 +10540,8 @@ declare enum HeightBreakpoint { * @enum {number} * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AxisModel { /** @@ -10122,7 +10549,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_X = 0, @@ -10132,7 +10560,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_Y = 1, @@ -10141,7 +10570,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_Z = 2, @@ -10150,7 +10580,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_RZ = 3, @@ -10159,7 +10590,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_GAS = 4, @@ -10168,7 +10600,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_BRAKE = 5, @@ -10177,7 +10610,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_HAT0X = 6, @@ -10186,7 +10620,8 @@ declare enum AxisModel { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ABS_HAT0Y = 7, } @@ -10199,7 +10634,8 @@ declare enum AxisModel { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PageFlipMode { /** @@ -10209,7 +10645,8 @@ declare enum PageFlipMode { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUOUS = 0, @@ -10220,7 +10657,8 @@ declare enum PageFlipMode { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ SINGLE = 1, } @@ -10231,7 +10669,8 @@ declare enum PageFlipMode { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CrownAction { /** @@ -10239,7 +10678,8 @@ declare enum CrownAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BEGIN = 0, @@ -10248,7 +10688,8 @@ declare enum CrownAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ UPDATE = 1, @@ -10257,7 +10698,8 @@ declare enum CrownAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ END = 2 } @@ -10268,7 +10710,8 @@ declare enum CrownAction { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CrownSensitivity { /** @@ -10276,7 +10719,8 @@ declare enum CrownSensitivity { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LOW = 0, @@ -10285,7 +10729,8 @@ declare enum CrownSensitivity { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIUM = 1, @@ -10294,7 +10739,8 @@ declare enum CrownSensitivity { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH = 2 } @@ -10305,7 +10751,8 @@ declare enum CrownSensitivity { * @enum {number} * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AxisAction { /** @@ -10313,7 +10760,8 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -10322,7 +10770,8 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BEGIN = 1, @@ -10331,7 +10780,8 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ UPDATE = 2, @@ -10340,7 +10790,8 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ END = 3, @@ -10349,7 +10800,8 @@ declare enum AxisAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 4, } @@ -10362,7 +10814,8 @@ declare enum AxisAction { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FocusDrawLevel { /** @@ -10372,7 +10825,8 @@ declare enum AxisAction { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SELF = 0, @@ -10383,7 +10837,8 @@ declare enum AxisAction { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TOP = 1, } @@ -10395,7 +10850,8 @@ declare enum AxisAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DividerMode { /** @@ -10404,7 +10860,8 @@ declare enum DividerMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FLOATING_ABOVE_MENU = 0, @@ -10414,7 +10871,8 @@ declare enum DividerMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED_IN_MENU = 1, } \ No newline at end of file diff --git a/api/@internal/component/ets/flex.d.ts b/api/@internal/component/ets/flex.d.ts index 9fd5c1b981f7199dbdd5c0bdbe2a848781fd1df0..8a3185e069aecaaabd63320991801647b03d1014 100644 --- a/api/@internal/component/ets/flex.d.ts +++ b/api/@internal/component/ets/flex.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { LengthMetrics } from '../Graphics'; +import { PointLightStyle, CommonMethod } from './common'; +import { FlexWrap, FlexDirection, ItemAlign, FlexAlign } from './enums'; +/*** endif */ + /** * Defines the options of Flex. * @@ -50,7 +56,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FlexOptions { /** @@ -85,7 +92,8 @@ declare interface FlexOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: FlexDirection; @@ -121,7 +129,8 @@ declare interface FlexOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ wrap?: FlexWrap; @@ -157,7 +166,8 @@ declare interface FlexOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ justifyContent?: FlexAlign; @@ -193,7 +203,8 @@ declare interface FlexOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignItems?: ItemAlign; @@ -229,7 +240,8 @@ declare interface FlexOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignContent?: FlexAlign; @@ -241,7 +253,8 @@ declare interface FlexOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ space?: FlexSpaceOptions; } @@ -254,7 +267,8 @@ declare interface FlexOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FlexSpaceOptions { @@ -265,7 +279,8 @@ declare interface FlexSpaceOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ main?: LengthMetrics; @@ -276,7 +291,8 @@ declare interface FlexSpaceOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cross?: LengthMetrics; } @@ -313,7 +329,8 @@ declare interface FlexSpaceOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface FlexInterface { /** @@ -352,7 +369,8 @@ interface FlexInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: FlexOptions): FlexAttribute; } @@ -389,7 +407,8 @@ interface FlexInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class FlexAttribute extends CommonMethod { /** @@ -399,7 +418,8 @@ declare class FlexAttribute extends CommonMethod { * @returns { FlexAttribute } The attribute of the flex. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pointLight(value: PointLightStyle): FlexAttribute; } diff --git a/api/@internal/component/ets/flow_item.d.ts b/api/@internal/component/ets/flow_item.d.ts index 83656920348360e55b7d6e14c4567918f07fc1e3..70cf009cce4621798a1bdf6ed9125db999f3e241 100644 --- a/api/@internal/component/ets/flow_item.d.ts +++ b/api/@internal/component/ets/flow_item.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common' +/*** endif */ + /** * Mesh container for static fixed-size layout scenarios. * @@ -40,7 +44,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface FlowItemInterface { /** @@ -65,7 +70,8 @@ interface FlowItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): FlowItemAttribute; } @@ -92,7 +98,8 @@ interface FlowItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class FlowItemAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/focus.d.ts b/api/@internal/component/ets/focus.d.ts index 495e4f6bbd24387a2f2cc8e0ce18ba47da37a708..3c69aa30b4703cdb38777afee2b87bf9bdf34371 100644 --- a/api/@internal/component/ets/focus.d.ts +++ b/api/@internal/component/ets/focus.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { LengthMetrics , ColorMetrics } from '../Graphics'; +/*** endif */ + /** * Focus box style. * @@ -25,7 +29,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FocusBoxStyle { /** @@ -35,7 +40,8 @@ declare interface FocusBoxStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: LengthMetrics; /** @@ -45,7 +51,8 @@ declare interface FocusBoxStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strokeColor?: ColorMetrics; /** @@ -55,7 +62,8 @@ declare interface FocusBoxStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: LengthMetrics; } @@ -67,7 +75,8 @@ declare interface FocusBoxStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FocusPriority { /** @@ -76,7 +85,8 @@ declare enum FocusPriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -86,7 +96,8 @@ declare enum FocusPriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIOR = 2000, @@ -96,11 +107,11 @@ declare enum FocusPriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIOUS = 3000, } - /** * Key processing mode. * Determines the priority of key event processing when component cannot handle the key event. @@ -109,7 +120,8 @@ declare enum FocusPriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum KeyProcessingMode { /** @@ -118,7 +130,8 @@ declare enum KeyProcessingMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_NAVIGATION = 0, @@ -128,7 +141,8 @@ declare enum KeyProcessingMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ANCESTOR_EVENT = 1, } \ No newline at end of file diff --git a/api/@internal/component/ets/folder_stack.d.ts b/api/@internal/component/ets/folder_stack.d.ts index 75c5045da64d85e7531eff1152a6d2300aed9d51..9e5d68592ae790d2a5a9fbeda1e74323799a6772 100644 --- a/api/@internal/component/ets/folder_stack.d.ts +++ b/api/@internal/component/ets/folder_stack.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import window from '../../@ohos.window'; +import { FoldStatus, Alignment, AppRotation } from './enums'; +import { CommonMethod } from './common'; +/*** endif */ + /** * Import the WindowStatusType type object for onHoverStatusChange. * @@ -28,6 +34,17 @@ */ declare type WindowStatusType = import('../api/@ohos.window').default.WindowStatusType; +/** + * Import the WindowStatusType type object for onHoverStatusChange. + * + * @typedef { window.WindowStatusType } WindowStatusType + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type WindowStatusType = window.WindowStatusType + /** * FolderStack constructor options. * @@ -35,7 +52,8 @@ declare type WindowStatusType = import('../api/@ohos.window').default.WindowStat * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ interface FolderStackOptions { /** @@ -53,7 +71,8 @@ interface FolderStackOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ upperItems?: Array; } @@ -73,7 +92,8 @@ interface FolderStackOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FolderStackInterface { @@ -104,7 +124,8 @@ interface FolderStackInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: FolderStackOptions): FolderStackAttribute; } @@ -116,7 +137,8 @@ interface FolderStackInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ interface OnFoldStatusChangeInfo { /** @@ -134,7 +156,8 @@ interface OnFoldStatusChangeInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ foldStatus: FoldStatus } @@ -147,22 +170,23 @@ interface OnFoldStatusChangeInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnFoldStatusChangeCallback = (event: OnFoldStatusChangeInfo) => void; /** * Callback when onHoverStatusChange. - * + * * @typedef { function } OnHoverStatusChangeCallback * @param { HoverEventParam } param - hover event param * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnHoverStatusChangeCallback = (param: HoverEventParam) => void; -/** /** * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -174,7 +198,8 @@ declare type OnHoverStatusChangeCallback = (param: HoverEventParam) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class FolderStackAttribute extends CommonMethod { /** @@ -194,7 +219,8 @@ declare class FolderStackAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alignContent(value: Alignment): FolderStackAttribute; @@ -225,7 +251,8 @@ declare class FolderStackAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onFolderStateChange(callback: OnFoldStatusChangeCallback): FolderStackAttribute; @@ -246,7 +273,8 @@ declare class FolderStackAttribute extends CommonMethod { * @returns { FolderStackAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onHoverStatusChange(handler: OnHoverStatusChangeCallback): FolderStackAttribute; @@ -267,7 +295,8 @@ declare class FolderStackAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAnimation(value: boolean): FolderStackAttribute; @@ -288,7 +317,8 @@ declare class FolderStackAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ autoHalfFold(value: boolean): FolderStackAttribute; } @@ -299,7 +329,8 @@ declare class FolderStackAttribute extends CommonMethod { * @interface HoverEventParam * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface HoverEventParam { /** @@ -308,7 +339,8 @@ declare interface HoverEventParam { * @type { FoldStatus } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ foldStatus: FoldStatus @@ -318,7 +350,8 @@ declare interface HoverEventParam { * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isHoverMode: boolean @@ -328,7 +361,8 @@ declare interface HoverEventParam { * @type { AppRotation } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ appRotation: AppRotation @@ -338,7 +372,8 @@ declare interface HoverEventParam { * @type { WindowStatusType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ windowStatusType: WindowStatusType } diff --git a/api/@internal/component/ets/form_component.d.ts b/api/@internal/component/ets/form_component.d.ts index ebca6b72b36e0c0c018abb653f8f769651af3ed7..076170caba5ae2ee5cda46d87c8c49c90f5858cd 100644 --- a/api/@internal/component/ets/form_component.d.ts +++ b/api/@internal/component/ets/form_component.d.ts @@ -17,14 +17,19 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { CommonMethod,Callback } from './common'; +import Want from '../../@ohos.app.ability.Want'; +import { Visibility } from './enums' +/*** endif */ /** * Defines the FormDimension enum. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FormDimension { /** @@ -32,7 +37,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_1_2, @@ -41,7 +47,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_2_2, @@ -50,7 +57,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_2_4, @@ -59,7 +67,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_4_4, @@ -68,7 +77,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_2_1, @@ -78,7 +88,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_1_1 = 6, @@ -87,7 +98,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_6_4, @@ -96,7 +108,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_2_3 = 8, @@ -105,7 +118,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_3_3 = 9, @@ -114,7 +128,8 @@ declare enum FormDimension { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_3_4 = 10, } @@ -125,7 +140,8 @@ declare enum FormDimension { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FormRenderingMode { @@ -134,7 +150,8 @@ declare enum FormRenderingMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FULL_COLOR, @@ -143,7 +160,8 @@ declare enum FormRenderingMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SINGLE_COLOR, } @@ -154,7 +172,8 @@ declare enum FormRenderingMode { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FormShape { /** @@ -162,7 +181,8 @@ declare enum FormShape { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RECT = 1, @@ -171,7 +191,8 @@ declare enum FormShape { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CIRCLE, } @@ -182,7 +203,8 @@ declare enum FormShape { * @interface FormInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FormInfo { /** @@ -191,7 +213,8 @@ declare interface FormInfo { * @type { number | string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: number | string; @@ -201,7 +224,8 @@ declare interface FormInfo { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -211,7 +235,8 @@ declare interface FormInfo { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bundle: string; @@ -221,7 +246,8 @@ declare interface FormInfo { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ability: string; @@ -231,7 +257,8 @@ declare interface FormInfo { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ module: string; @@ -241,7 +268,8 @@ declare interface FormInfo { * @type { ?FormDimension } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dimension?: FormDimension; @@ -251,7 +279,8 @@ declare interface FormInfo { * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ temporary?: boolean; @@ -265,13 +294,25 @@ declare interface FormInfo { */ want?: import('../api/@ohos.app.ability.Want').default; + /** + * The want of the form. + * + * @type { ?import('../api/@ohos.app.ability.Want').default } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + want?: Want; + /** * The renderingMode of the form. * * @type { ?FormRenderingMode } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderingMode?: FormRenderingMode; @@ -281,7 +322,8 @@ declare interface FormInfo { * @type { ?FormShape } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shape?: FormShape; } @@ -292,7 +334,8 @@ declare interface FormInfo { * @interface FormComponentInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ interface FormComponentInterface { /** @@ -338,7 +381,8 @@ interface FormComponentInterface { * @returns { FormComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (value: FormInfo): FormComponentAttribute; } @@ -349,7 +393,8 @@ interface FormComponentInterface { * @interface FormCallbackInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FormCallbackInfo { /** @@ -358,7 +403,8 @@ interface FormCallbackInfo { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -368,16 +414,81 @@ interface FormCallbackInfo { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ idString: string; } +/** + * Defines the FormCallbackInfo. + * + * @interface FormSize + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ +interface FormSize { + /** + * The string id of the form. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + width: number; + /** + * The string id of the form. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + height: number; +} + +/** + * Defines the FormCallbackInfo. + * + * @interface FormError + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ +interface FormError { + /** + * The string id of the form. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + errcode: number; + /** + * The string id of the form. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + msg: string +} /** * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ declare class FormComponentAttribute extends CommonMethod { /** @@ -391,6 +502,18 @@ declare class FormComponentAttribute extends CommonMethod): FormComponentAttribute; @@ -468,6 +596,18 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; + /** + * Card loading error. + * + * @param { Callback } callback + * @returns { FormComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + onError(callback: Callback): FormComponentAttribute; + /** * Card to be redirected. * @@ -479,6 +619,18 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; + /** + * Card to be redirected. + * + * @param { function } callback + * @returns { FormComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + onRouter(callback: Callback): FormComponentAttribute; + /** * Uninstall Card. * @@ -495,7 +647,8 @@ declare class FormComponentAttribute extends CommonMethod): FormComponentAttribute; @@ -506,7 +659,8 @@ declare class FormComponentAttribute extends CommonMethod void): FormComponentAttribute; } diff --git a/api/@internal/component/ets/form_link.d.ts b/api/@internal/component/ets/form_link.d.ts index 86479323501246859e6f83569e0ccbabde92fcf2..700211a7b821455ff4ea0cb067e6e741d61ad59c 100644 --- a/api/@internal/component/ets/form_link.d.ts +++ b/api/@internal/component/ets/form_link.d.ts @@ -17,7 +17,9 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { CommonMethod} from './common'; +/*** endif */ /** * Defines the FormLink options. * @@ -25,7 +27,7 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @since 10 -*/ + */ /** * Defines the FormLink options. * @@ -33,8 +35,9 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 -*/ + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 + */ declare interface FormLinkOptions { /** * Action types: "router" and "message". @@ -51,7 +54,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ action: string; @@ -70,7 +74,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName?: string; @@ -89,7 +94,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName?: string; @@ -108,7 +114,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ abilityName?: string; @@ -119,7 +126,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ uri?: string; @@ -138,7 +146,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ params?: Object; } @@ -158,7 +167,8 @@ declare interface FormLinkOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface FormLinkInterface { /** @@ -178,7 +188,8 @@ interface FormLinkInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ (options: FormLinkOptions): FormLinkAttribute; } @@ -198,10 +209,10 @@ interface FormLinkInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -declare class FormLinkAttribute extends CommonMethod { -} +declare class FormLinkAttribute extends CommonMethod {} /** * Defines FormLink component. diff --git a/api/@internal/component/ets/gauge.d.ts b/api/@internal/component/ets/gauge.d.ts index 5ec51b4b5af5c7a2243b309eb9140e62d6cc120a..0d3ebe2d139d1a8d8a32a3f135911025f412f34c 100644 --- a/api/@internal/component/ets/gauge.d.ts +++ b/api/@internal/component/ets/gauge.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod,CommonConfiguration,ContentModifier,MultiShadowOptions,Optional } from './common' +import { CustomBuilder } from './builder' +import { ResourceStr,Dimension,ResourceColor,Length } from './units' +import { LinearGradient } from './dataPanel' +/*** endif */ + /** * Defines Gauge constructor options. * @@ -26,7 +33,8 @@ * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface GaugeOptions { /** @@ -63,6 +71,18 @@ interface GaugeOptions { * @atomicservice * @since 11 */ + /** + * Set current data value. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ value: number; /** @@ -99,6 +119,18 @@ interface GaugeOptions { * @atomicservice * @since 11 */ + /** + * Set current segment minimum value. + * Anonymous Object Rectification. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ min?: number; /** @@ -135,6 +167,18 @@ interface GaugeOptions { * @atomicservice * @since 11 */ + /** + * Set current segment maximum value. + * Anonymous Object Rectification. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ max?: number; } @@ -170,7 +214,8 @@ interface GaugeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface GaugeInterface { /** @@ -221,6 +266,7 @@ interface GaugeInterface { */ /** * Called when the gauge component is used. + * Anonymous Object Rectification. * * @param { GaugeOptions } options - Gauge options. * @returns { GaugeAttribute } @@ -228,7 +274,8 @@ interface GaugeInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options: GaugeOptions): GaugeAttribute; } @@ -250,7 +297,8 @@ interface GaugeInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GaugeShadowOptions extends MultiShadowOptions {} @@ -269,7 +317,8 @@ declare interface GaugeShadowOptions extends MultiShadowOptions {} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GaugeIndicatorOptions { @@ -290,7 +339,8 @@ declare interface GaugeIndicatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: ResourceStr; @@ -311,7 +361,8 @@ declare interface GaugeIndicatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ space?: Dimension; } @@ -324,7 +375,8 @@ declare interface GaugeIndicatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GaugeConfiguration extends CommonConfiguration { /** @@ -334,7 +386,8 @@ declare interface GaugeConfiguration extends CommonConfiguration { /** @@ -424,7 +480,8 @@ declare class GaugeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value(value: number): GaugeAttribute; @@ -464,7 +521,8 @@ declare class GaugeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startAngle(angle: number): GaugeAttribute; @@ -504,7 +562,8 @@ declare class GaugeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endAngle(angle: number): GaugeAttribute; @@ -544,7 +603,8 @@ declare class GaugeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ colors(colors: ResourceColor | LinearGradient | Array<[ResourceColor | LinearGradient, number]>): GaugeAttribute; @@ -584,7 +644,8 @@ declare class GaugeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth(length: Length): GaugeAttribute; @@ -605,7 +666,8 @@ declare class GaugeAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ description(value: CustomBuilder): GaugeAttribute; @@ -626,7 +688,8 @@ declare class GaugeAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ trackShadow(value: GaugeShadowOptions): GaugeAttribute; @@ -647,7 +710,8 @@ declare class GaugeAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ indicator(value: GaugeIndicatorOptions): GaugeAttribute; @@ -660,7 +724,8 @@ declare class GaugeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ privacySensitive(isPrivacySensitiveMode: Optional): GaugeAttribute; @@ -672,7 +737,8 @@ declare class GaugeAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): GaugeAttribute; } diff --git a/api/@internal/component/ets/gesture.d.ts b/api/@internal/component/ets/gesture.d.ts index 5abb03c59ac2456efffb5293c0f89533b3049dc9..9cbc52b43fd320e7323ffcc36fae341aa46fe10f 100644 --- a/api/@internal/component/ets/gesture.d.ts +++ b/api/@internal/component/ets/gesture.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { BaseEvent, SourceTool, Callback } from './common' +import { InteractionHand } from './enums' +/*** endif */ + /** * Creating an Object * @@ -40,7 +45,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PanDirection { /** @@ -62,7 +68,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -85,7 +92,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Horizontal, @@ -108,7 +116,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, @@ -131,7 +140,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -154,7 +164,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Vertical, @@ -177,7 +188,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Up, @@ -200,7 +212,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Down, @@ -223,7 +236,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ All, } @@ -250,7 +264,8 @@ declare enum PanDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SwipeDirection { /** @@ -272,7 +287,8 @@ declare enum SwipeDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -295,7 +311,8 @@ declare enum SwipeDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Horizontal, @@ -318,7 +335,8 @@ declare enum SwipeDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Vertical, @@ -341,7 +359,8 @@ declare enum SwipeDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ All, } @@ -368,7 +387,8 @@ declare enum SwipeDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GestureMode { /** @@ -390,7 +410,8 @@ declare enum GestureMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Sequence, @@ -413,7 +434,8 @@ declare enum GestureMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Parallel, @@ -436,7 +458,8 @@ declare enum GestureMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Exclusive, } @@ -463,7 +486,8 @@ declare enum GestureMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GestureMask { /** @@ -485,7 +509,8 @@ declare enum GestureMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -508,7 +533,8 @@ declare enum GestureMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ IgnoreInternal, } @@ -528,7 +554,8 @@ declare enum GestureMask { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GestureJudgeResult { /** @@ -544,7 +571,8 @@ declare enum GestureJudgeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUE = 0, @@ -561,7 +589,8 @@ declare enum GestureJudgeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REJECT = 1, } @@ -581,7 +610,8 @@ declare enum GestureJudgeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace GestureControl { /** @@ -599,7 +629,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum GestureType { /** @@ -615,7 +646,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TAP_GESTURE = 0, @@ -632,7 +664,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LONG_PRESS_GESTURE = 1, @@ -649,7 +682,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PAN_GESTURE = 2, @@ -666,7 +700,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PINCH_GESTURE = 3, @@ -683,7 +718,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SWIPE_GESTURE = 4, @@ -700,7 +736,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_GESTURE = 5, @@ -717,7 +754,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DRAG = 6, @@ -734,7 +772,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CLICK = 7, } @@ -755,7 +794,8 @@ declare namespace GestureControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GestureInfo { /** @@ -773,7 +813,8 @@ declare interface GestureInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ tag?: string; @@ -792,7 +833,8 @@ declare interface GestureInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: GestureControl.GestureType; @@ -811,7 +853,8 @@ declare interface GestureInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isSystemGesture: boolean; } @@ -838,7 +881,8 @@ declare interface GestureInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface FingerInfo { /** @@ -863,7 +907,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -889,7 +934,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ globalX: number; @@ -915,7 +961,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ globalY: number; @@ -941,7 +988,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ localX: number; @@ -967,7 +1015,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ localY: number; @@ -978,7 +1027,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ displayX: number; @@ -989,7 +1039,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ displayY: number; @@ -1000,7 +1051,8 @@ interface FingerInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ hand?: InteractionHand; } @@ -1038,6 +1090,18 @@ declare type GestureType = | RotationGestureInterface | GestureGroupInterface; +/** + * Defines the Gesture Type. + * + * @typedef { Gesture | GestureGroup } GestureType + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export type GestureType = Gesture | GestureGroup; + /** * Defines the gesture base event. * @@ -1055,7 +1119,8 @@ declare type GestureType = * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface BaseGestureEvent extends BaseEvent { /** @@ -1073,7 +1138,8 @@ interface BaseGestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fingerList: FingerInfo[]; } @@ -1095,7 +1161,8 @@ interface BaseGestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface TapGestureEvent extends BaseGestureEvent { } @@ -1117,7 +1184,8 @@ interface TapGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface LongPressGestureEvent extends BaseGestureEvent { /** @@ -1135,7 +1203,8 @@ interface LongPressGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ repeat: boolean; } @@ -1157,7 +1226,8 @@ interface LongPressGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PanGestureEvent extends BaseGestureEvent { /** @@ -1177,7 +1247,8 @@ interface PanGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offsetX: number; @@ -1198,7 +1269,8 @@ interface PanGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offsetY: number; @@ -1215,7 +1287,8 @@ interface PanGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ velocityX: number; @@ -1232,7 +1305,8 @@ interface PanGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ velocityY: number; @@ -1249,7 +1323,8 @@ interface PanGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ velocity: number; } @@ -1271,7 +1346,8 @@ interface PanGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PinchGestureEvent extends BaseGestureEvent { /** @@ -1289,7 +1365,8 @@ interface PinchGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scale: number; @@ -1310,7 +1387,8 @@ interface PinchGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pinchCenterX: number; @@ -1331,7 +1409,8 @@ interface PinchGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pinchCenterY: number; } @@ -1353,7 +1432,8 @@ interface PinchGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RotationGestureEvent extends BaseGestureEvent { /** @@ -1373,7 +1453,8 @@ interface RotationGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ angle: number; } @@ -1395,7 +1476,8 @@ interface RotationGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 112 + * @since arkts {'1.1':'112','1.2':'20'} + * @arkts 1.1&1.2 */ interface SwipeGestureEvent extends BaseGestureEvent { /** @@ -1415,7 +1497,8 @@ interface SwipeGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ angle: number; @@ -1436,7 +1519,8 @@ interface SwipeGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ speed: number; } @@ -1466,7 +1550,8 @@ interface SwipeGestureEvent extends BaseGestureEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface GestureEvent extends BaseEvent { /** @@ -1494,7 +1579,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ repeat: boolean; @@ -1523,7 +1609,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fingerList: FingerInfo[]; @@ -1555,7 +1642,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetX: number; @@ -1587,7 +1675,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetY: number; @@ -1619,7 +1708,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ angle: number; @@ -1651,7 +1741,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ speed: number; @@ -1680,7 +1771,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scale: number; @@ -1712,7 +1804,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pinchCenterX: number; @@ -1744,7 +1837,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pinchCenterY: number; @@ -1761,7 +1855,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ velocityX: number; @@ -1778,7 +1873,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ velocityY: number; @@ -1795,7 +1891,8 @@ interface GestureEvent extends BaseEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ velocity: number; } @@ -1841,7 +1938,8 @@ interface GestureInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface BaseHandlerOptions { /** @@ -1852,11 +1950,49 @@ interface GestureInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ isFingerCountLimited?: boolean; } +/** + * Defines Gesture interface. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export declare class Gesture { + /** + * Set gesture's tag. + * + * @param { string } tag + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + tag(tag: string): this; + + /** + * Input source type for gesture response. + * + * @param { Array } types - indicate the allowed input source for gesture to response + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + allowedTypes(types: Array): this; +} + /** * Defines TapGesture parameters. * @@ -1874,7 +2010,8 @@ interface GestureInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TapGestureParameters extends BaseHandlerOptions { /** @@ -1884,7 +2021,8 @@ declare interface TapGestureParameters extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ count?: number; /** @@ -1894,7 +2032,8 @@ declare interface TapGestureParameters extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fingers?: number; /** @@ -1904,7 +2043,8 @@ declare interface TapGestureParameters extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ distanceThreshold?: number; } @@ -2013,6 +2153,46 @@ interface TapGestureInterface extends GestureInterface { onAction(event: (event: GestureEvent) => void): TapGestureInterface; } +/*** if arkts 1.2 */ +/** + * Defines TapGesture. + * + * @extends Gesture + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class TapGesture extends Gesture { + /** + * Set the value. + * TapGestureParameters: The parameters of the tapGesture. + * + * @param { function } factory + * @param { TapGestureParameters } value + * @returns { TapGesture } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + static $_instantiate(factory: () => TapGesture, value?: TapGestureParameters): TapGesture + + /** + * Tap gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onAction(event: Callback): this; +} +/*** endif */ + /** * Defines LongPressGesture interface. * @@ -2190,6 +2370,72 @@ interface LongPressGestureInterface extends GestureInterface): LongPressGestureInterface; } +/*** if arkts 1.2 */ +/** + * Defines LongPressGesture. + * + * @extends Gesture + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class LongPressGesture extends Gesture { + /** + * Set the value. + * fingers: Indicates the hand index that triggers the long press. + * repeat: Indicates whether to trigger event callback continuously. + * duration: Minimum press and hold time, in milliseconds. + * + * @param { function } factory + * @param { LongPressGestureHandlerOptions } value + * @returns { LongPressGesture } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + static $_instantiate(factory: () => LongPressGesture, value?: LongPressGestureHandlerOptions): LongPressGesture + + /** + * LongPress gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onAction(event: Callback): this; + + /** + * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + + /** + * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the PanGesture options. * @@ -2209,7 +2455,8 @@ interface LongPressGestureInterface extends GestureInterface { } +/*** if arkts 1.2 */ /** - * Defines the SwipeGesture interface. - * - * @extends GestureInterface - * @interface SwipeGestureInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 8 - */ -/** - * Defines the SwipeGesture interface. - * - * @extends GestureInterface - * @interface SwipeGestureInterface - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ -/** - * Defines SwipeGesture interface extends GestureInterface. + * Defines PanGesture. * - * @extends GestureInterface - * @interface SwipeGestureInterface + * @extends Gesture * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since 20 */ -interface SwipeGestureInterface extends GestureInterface { +export declare class PanGesture extends Gesture { /** * Set the value. * - * @param { object } value - * @returns { SwipeGestureInterface } + * @param { function } factory + * @param { PanGestureHandlerOptions | PanGestureOptions } value + * @returns { PanGesture } + * @static * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 8 + * @crossplatform + * @atomicservice + * @since 20 */ + static $_instantiate(factory: () => PanGesture, value?: PanGestureHandlerOptions | PanGestureOptions): PanGesture + /** - * Set the value. + * Pan gesture recognition success callback. * - * @param { object } value - * @returns { SwipeGestureInterface } + * @param { Callback } event + * @returns { this } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 10 + * @atomicservice + * @since 20 + */ + onActionStart(event: Callback): this; + + /** + * Callback when the Pan gesture is moving. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionUpdate(event: Callback): this; + + /** + * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + + /** + * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + +/** + * Defines the SwipeGesture interface. + * + * @extends GestureInterface + * @interface SwipeGestureInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 8 + */ +/** + * Defines the SwipeGesture interface. + * + * @extends GestureInterface + * @interface SwipeGestureInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Defines SwipeGesture interface extends GestureInterface. + * + * @extends GestureInterface + * @interface SwipeGestureInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +interface SwipeGestureInterface extends GestureInterface { + /** + * Set the value. + * + * @param { object } value + * @returns { SwipeGestureInterface } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 8 + */ + /** + * Set the value. + * + * @param { object } value + * @returns { SwipeGestureInterface } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 */ /** * Set the value. @@ -2637,6 +3009,45 @@ interface SwipeGestureInterface extends GestureInterface onAction(event: (event: GestureEvent) => void): SwipeGestureInterface; } +/*** if arkts 1.2 */ +/** + * Defines SwipeGesture. + * + * @extends Gesture + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class SwipeGesture extends Gesture { + /** + * Set the value. + * + * @param { function } factory + * @param { SwipeGestureHandlerOptions } value + * @returns { SwipeGesture } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + static $_instantiate(factory: () => SwipeGesture, value?: SwipeGestureHandlerOptions): SwipeGesture + + /** + * Slide gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onAction(event: Callback): this; +} +/*** endif */ + /** * Defines the PinchGesture interface. * @@ -2835,6 +3246,81 @@ interface PinchGestureInterface extends GestureInterface onActionCancel(event: Callback): PinchGestureInterface; } +/*** if arkts 1.2 */ +/** + * Defines PinchGesture. + * + * @extends Gesture + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class PinchGesture extends Gesture { + /** + * Set the value. + * + * @param { function } factory + * @param { PinchGestureHandlerOptions } value + * @returns { PinchGesture } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + static $_instantiate(factory: () => PinchGesture, value?: PinchGestureHandlerOptions): PinchGesture + + /** + * Pinch gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionStart(event: Callback): this; + + /** + * Callback when the Pinch gesture is moving. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionUpdate(event: Callback): this; + + /** + * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + + /** + * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the RotationGesture interface. * @@ -3033,6 +3519,81 @@ interface RotationGestureInterface extends GestureInterface): RotationGestureInterface; } +/*** if arkts 1.2 */ +/** + * Defines RotationGesture. + * + * @extends Gesture + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class RotationGesture extends Gesture { + /** + * Set the value. + * + * @param { function } factory + * @param { RotationGestureHandlerOptions } value + * @returns { RotationGesture } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + static $_instantiate(factory: () => RotationGesture, value?: RotationGestureHandlerOptions): RotationGesture + + /** + * Rotation gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionStart(event: Callback): this; + + /** + * Callback when the Rotation gesture is moving. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionUpdate(event: Callback): this; + + /** + * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + + /** + * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the GestureGroup interface. * @@ -3120,6 +3681,45 @@ interface GestureGroupInterface { onCancel(event: () => void): GestureGroupInterface; } +/*** if arkts 1.2 */ +/** + * Defines the GestureGroup. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class GestureGroup { + /** + * Return to Obtain GestureGroup. + * + * @param { function } factory + * @param { GestureMode } mode + * @param { GestureType[] } gesture + * @returns { GestureGroup } + * @static + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + static $_instantiate(factory: () => GestureGroup, mode: GestureMode, ...gesture: GestureType[]): GestureGroup; + + /** + * The Gesture group is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { GestureGroup } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onCancel(event: Callback): GestureGroup; +} +/*** endif */ + /** * Defines TapGesture Component. * @@ -3316,6 +3916,42 @@ declare class GestureHandler implements GestureInterface { allowedTypes(types: Array): T; } +/*** if arkts 1.2 */ +/** + * Defines the gesture handler. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class GestureHandler { + /** + * Set the GestureHandler's tag. + * + * @param { string } tag + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + tag(tag: string): this; + + /** + * Input source type for gesture response. + * + * @param { Array } types - indicate the allowed input source for gesture to response + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + allowedTypes(types: Array): this; +} +/*** endif */ + /** * Defines the TapGestureHandler options. * @@ -3333,7 +3969,8 @@ declare class GestureHandler implements GestureInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface TapGestureHandlerOptions extends BaseHandlerOptions { /** @@ -3344,7 +3981,8 @@ interface TapGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ count?: number; /** @@ -3355,7 +3993,8 @@ interface TapGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fingers?: number; } @@ -3393,6 +4032,41 @@ declare class TapGestureHandler extends GestureHandler { onAction(event: Callback): TapGestureHandler; } +/*** if arkts 1.2 */ +/** + * Defines the TapGesture handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class TapGestureHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { TapGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: TapGestureHandlerOptions); + /** + * Tap gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onAction(event: Callback): this; +} +/*** endif */ + /** * Defines the LongPressGestureHandler options. * @@ -3410,7 +4084,8 @@ declare class TapGestureHandler extends GestureHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface LongPressGestureHandlerOptions extends BaseHandlerOptions { /** @@ -3421,7 +4096,8 @@ interface LongPressGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fingers?: number; /** @@ -3432,7 +4108,8 @@ interface LongPressGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ repeat?: boolean; /** @@ -3443,7 +4120,8 @@ interface LongPressGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; } @@ -3515,6 +4193,63 @@ declare class LongPressGestureHandler extends GestureHandler): LongPressGestureHandler; } +/*** if arkts 1.2 */ +/** + * Defines the LongPressGesture handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class LongPressGestureHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { LongPressGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: LongPressGestureHandlerOptions); + /** + * LongPress gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onAction(event: Callback): this; + /** + * The LongPress gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + /** + * The LongPress gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the PanGestureHandler options. * @@ -3532,7 +4267,8 @@ declare class LongPressGestureHandler extends GestureHandler { onActionCancel(event: Callback): PanGestureHandler; } +/*** if arkts 1.2 */ +/** + * Defines the PanGesture handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class PanGestureHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { PanGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: PanGestureHandlerOptions); + /** + * Pan gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionStart(event: Callback): this; + /** + * Callback when the Pan gesture is moving. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionUpdate(event: Callback): this; + /** + * The Pan gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + /** + * The Pan gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the SwipeGestureHandler options. * @@ -3665,7 +4472,8 @@ declare class PanGestureHandler extends GestureHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface SwipeGestureHandlerOptions extends BaseHandlerOptions { /** @@ -3676,7 +4484,8 @@ interface SwipeGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fingers?: number; /** @@ -3687,7 +4496,8 @@ interface SwipeGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: SwipeDirection; /** @@ -3698,7 +4508,8 @@ interface SwipeGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ speed?: number; } @@ -3736,6 +4547,41 @@ declare class SwipeGestureHandler extends GestureHandler { onAction(event: Callback): SwipeGestureHandler; } +/*** if arkts 1.2 */ +/** + * Defines the SwipeGesture handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class SwipeGestureHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { SwipeGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: SwipeGestureHandlerOptions); + /** + * Swipe gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onAction(event: Callback): this; +} +/*** endif */ + /** * Defines the PinchGestureHandler options. * @@ -3753,7 +4599,8 @@ declare class SwipeGestureHandler extends GestureHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface PinchGestureHandlerOptions extends BaseHandlerOptions { /** @@ -3764,7 +4611,8 @@ interface PinchGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fingers?: number; /** @@ -3775,7 +4623,8 @@ interface PinchGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ distance?: number; } @@ -3858,6 +4707,74 @@ declare class PinchGestureHandler extends GestureHandler { onActionCancel(event: Callback): PinchGestureHandler; } +/*** if arkts 1.2 */ +/** + * Defines the PinchGesture handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class PinchGestureHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { PinchGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: PinchGestureHandlerOptions); + /** + * Pinch gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionStart(event: Callback): this; + /** + * Callback when the Pinch gesture is moving. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionUpdate(event: Callback): this; + /** + * The Pinch gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + /** + * The Pinch gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the RotationGestureHandler options. * @@ -3875,7 +4792,8 @@ declare class PinchGestureHandler extends GestureHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface RotationGestureHandlerOptions extends BaseHandlerOptions { /** @@ -3886,7 +4804,8 @@ interface RotationGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fingers?: number; /** @@ -3897,7 +4816,8 @@ interface RotationGestureHandlerOptions extends BaseHandlerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ angle?: number; } @@ -3980,6 +4900,74 @@ declare class RotationGestureHandler extends GestureHandler): RotationGestureHandler; } +/*** if arkts 1.2 */ +/** + * Defines the RotationGesture handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class RotationGestureHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { RotationGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: RotationGestureHandlerOptions); + /** + * Rotation gesture recognition success callback. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionStart(event: Callback): this; + /** + * Callback when the Rotation gesture is moving. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionUpdate(event: Callback): this; + /** + * The Rotation gesture is successfully recognized. When the finger is lifted, the callback is triggered. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionEnd(event: Callback): this; + /** + * The Rotation gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onActionCancel(event: Callback): this; +} +/*** endif */ + /** * Defines the GestureGroupGestureHandler options. * @@ -3987,7 +4975,8 @@ declare class RotationGestureHandler extends GestureHandler[]; + /** + * Indicates the gestures included in the gesture group. + * + * @type { GestureHandler[] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + gestures: GestureHandler[]; } /** @@ -4045,6 +5046,41 @@ declare class GestureGroupHandler extends GestureHandler { onCancel(event: Callback): GestureGroupHandler; } +/*** if arkts 1.2 */ +/** + * Defines the GestureGroup handler. + * + * @extends GestureHandler + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ +export declare class GestureGroupHandler extends GestureHandler { + /** + * Constructor parameters. + * + * @param { GestureGroupGestureHandlerOptions } options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + constructor(options?: GestureGroupGestureHandlerOptions); + /** + * The GestureGroup gesture is successfully recognized and a callback is triggered when the touch cancel event is received. + * + * @param { Callback } event + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + onCancel(event: Callback): this; +} +/*** endif */ + /** * Creating an Object * @@ -4052,7 +5088,8 @@ declare class GestureGroupHandler extends GestureHandler { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GesturePriority { /** @@ -4061,7 +5098,8 @@ declare enum GesturePriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, /** @@ -4070,7 +5108,8 @@ declare enum GesturePriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIORITY = 1, } @@ -4082,7 +5121,8 @@ declare enum GesturePriority { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GestureRecognizerState { /** @@ -4091,7 +5131,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ READY = 0, /** @@ -4100,7 +5141,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DETECTING = 1, /** @@ -4109,7 +5151,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PENDING = 2, /** @@ -4118,7 +5161,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BLOCKED = 3, /** @@ -4127,7 +5171,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUCCESSFUL = 4, /** @@ -4136,7 +5181,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FAILED = 5, } @@ -4148,7 +5194,8 @@ declare enum GestureRecognizerState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScrollableTargetInfo extends EventTargetInfo { /** @@ -4158,7 +5205,8 @@ declare class ScrollableTargetInfo extends EventTargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isBegin(): boolean; /** @@ -4168,7 +5216,8 @@ declare class ScrollableTargetInfo extends EventTargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isEnd(): boolean; } @@ -4179,7 +5228,8 @@ declare class ScrollableTargetInfo extends EventTargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class EventTargetInfo { /** @@ -4189,7 +5239,8 @@ declare class EventTargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getId(): string; } @@ -4200,7 +5251,8 @@ declare class EventTargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class GestureRecognizer { /** @@ -4210,7 +5262,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getTag(): string; /** @@ -4220,7 +5273,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getType(): GestureControl.GestureType; /** @@ -4230,7 +5284,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isBuiltIn(): boolean; /** @@ -4240,7 +5295,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setEnabled(isEnabled: boolean): void; /** @@ -4250,7 +5306,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isEnabled(): boolean; /** @@ -4260,7 +5317,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getState(): GestureRecognizerState; /** @@ -4270,7 +5328,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getEventTargetInfo(): EventTargetInfo; /** @@ -4279,7 +5338,8 @@ declare class GestureRecognizer { * @returns { boolean } - true is valid, false is invalid * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isValid(): boolean; /** @@ -4289,7 +5349,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getFingerCount(): number; /** @@ -4299,7 +5360,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ isFingerCountLimit(): boolean; } @@ -4311,7 +5373,8 @@ declare class GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TapRecognizer extends GestureRecognizer { /** @@ -4321,7 +5384,8 @@ declare class TapRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getTapCount(): number; } @@ -4333,7 +5397,8 @@ declare class TapRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LongPressRecognizer extends GestureRecognizer { /** @@ -4343,7 +5408,8 @@ declare class LongPressRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ isRepeat(): boolean; /** @@ -4354,7 +5420,8 @@ declare class LongPressRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getDuration(): number; } @@ -4366,7 +5433,8 @@ declare class LongPressRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SwipeRecognizer extends GestureRecognizer { /** @@ -4377,7 +5445,8 @@ declare class SwipeRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getVelocityThreshold(): number; /** @@ -4387,7 +5456,8 @@ declare class SwipeRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getDirection(): SwipeDirection; } @@ -4399,7 +5469,8 @@ declare class SwipeRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class PinchRecognizer extends GestureRecognizer { /** @@ -4410,7 +5481,8 @@ declare class PinchRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getDistance(): number; } @@ -4422,7 +5494,8 @@ declare class PinchRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RotationRecognizer extends GestureRecognizer { /** @@ -4432,7 +5505,8 @@ declare class RotationRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getAngle(): number; } @@ -4444,7 +5518,8 @@ declare class RotationRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class PanRecognizer extends GestureRecognizer { /** @@ -4454,7 +5529,8 @@ declare class PanRecognizer extends GestureRecognizer { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getPanGestureOptions(): PanGestureOptions; } diff --git a/api/@internal/component/ets/grid.d.ts b/api/@internal/component/ets/grid.d.ts index 96e929ecb57f83ee9638b24df15b3e8e493672fa..7e1cf1ef876fd9943b65078e2c32a5786f05be20 100644 --- a/api/@internal/component/ets/grid.d.ts +++ b/api/@internal/component/ets/grid.d.ts @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { EdgeEffectOptions, NestedScrollOptions, ItemDragInfo, ScrollableCommonMethod, Optional, CommonMethod, OnWillScrollCallback, OnScrollCallback, OnItemDragStartCallback } from './common'; +import { Length, Resource } from './units'; +import { Scroller, OnScrollFrameBeginCallback } from './scroll'; +import { ScrollState } from './list'; +import { BarState, Color, EdgeEffect } from './enums'; +/*** endif */ + /** * The options to help grid layout * @@ -33,7 +41,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridLayoutOptions { /** @@ -51,7 +60,8 @@ declare interface GridLayoutOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ regularSize: [number, number]; @@ -72,7 +82,8 @@ declare interface GridLayoutOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ irregularIndexes?: number[]; @@ -93,7 +104,8 @@ declare interface GridLayoutOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onGetIrregularSizeByIndex?: (index: number) => [number, number] @@ -114,7 +126,8 @@ declare interface GridLayoutOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onGetRectByIndex?: (index: number) => [number, number, number, number] } @@ -141,7 +154,8 @@ declare interface GridLayoutOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface GridInterface { /** @@ -171,7 +185,8 @@ interface GridInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (scroller?: Scroller, layoutOptions?: GridLayoutOptions): GridAttribute; } @@ -198,7 +213,8 @@ interface GridInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GridDirection { /** @@ -220,7 +236,8 @@ declare enum GridDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Row, @@ -243,7 +260,8 @@ declare enum GridDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Column, @@ -266,7 +284,8 @@ declare enum GridDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RowReverse, @@ -289,7 +308,8 @@ declare enum GridDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ColumnReverse, } @@ -301,7 +321,8 @@ declare enum GridDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GridItemAlignment { @@ -311,7 +332,8 @@ declare enum GridItemAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -322,7 +344,8 @@ declare enum GridItemAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STRETCH = 1, } @@ -342,7 +365,8 @@ declare enum GridItemAlignment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ComputedBarAttribute { /** @@ -360,7 +384,8 @@ declare interface ComputedBarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ totalOffset: number; @@ -379,7 +404,8 @@ declare interface ComputedBarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ totalLength: number; } @@ -406,7 +432,8 @@ declare interface ComputedBarAttribute { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class GridAttribute extends ScrollableCommonMethod { /** @@ -434,7 +461,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ columnsTemplate(value: string): GridAttribute; @@ -463,7 +491,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rowsTemplate(value: string): GridAttribute; @@ -492,7 +521,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ columnsGap(value: Length): GridAttribute; @@ -521,7 +551,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rowsGap(value: Length): GridAttribute; @@ -633,7 +664,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollBarUpdate(event: (index: number, offset: number) => ComputedBarAttribute): GridAttribute; @@ -667,7 +699,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollIndex(event: (first: number, last: number) => void): GridAttribute; @@ -696,7 +729,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cachedCount(value: number): GridAttribute; @@ -708,7 +742,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ cachedCount(count: number, show: boolean): GridAttribute; @@ -737,7 +772,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ editMode(value: boolean): GridAttribute; @@ -766,7 +802,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ multiSelectable(value: boolean): GridAttribute; @@ -795,7 +832,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxCount(value: number): GridAttribute; @@ -824,7 +862,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ minCount(value: number): GridAttribute; @@ -853,7 +892,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cellLength(value: number): GridAttribute; @@ -882,7 +922,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ layoutDirection(value: GridDirection): GridAttribute; @@ -911,7 +952,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ supportAnimation(value: boolean): GridAttribute; @@ -947,6 +989,19 @@ declare class GridAttribute extends ScrollableCommonMethod { */ onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) | void): GridAttribute; + /** + * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. + * (To be triggered, press and hold for 170 milliseconds (ms)) + * + * @param { OnItemDragStartCallback } event + * @returns { GridAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onItemDragStart(event: OnItemDragStartCallback): GridAttribute; + /** * After binding, a callback is triggered when the component is dragged to the range of the component. * @@ -972,7 +1027,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDragEnter(event: (event: ItemDragInfo) => void): GridAttribute; @@ -1001,7 +1057,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void): GridAttribute; @@ -1030,7 +1087,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void): GridAttribute; @@ -1062,7 +1120,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDrop( event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void, @@ -1160,7 +1219,8 @@ declare class GridAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alignItems(alignment: Optional): GridAttribute; @@ -1296,7 +1356,44 @@ declare class GridAttribute extends ScrollableCommonMethod { * @atomicservice * @since 11 */ - onScrollFrameBegin(event: (offset: number, state: ScrollState) => { offsetRemain: number }): GridAttribute; + /** + * Called when scrolling begin each frame. + * Anonymous Object Rectification. + * + * @param { OnScrollFrameBeginCallback } event - callback function, triggered when the scrolling begin each frame. + * @returns { GridAttribute } Returns the instance of the GridAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + onScrollFrameBegin(event: OnScrollFrameBeginCallback): GridAttribute; + + /** + * Called when the scrollable will scroll. + * + * @param { Optional } handler - callback of scrollable. + * @returns { GridAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onWillScroll(handler: Optional): GridAttribute; + + /** + * Called when the scrollable did scroll. + * + * @param { OnScrollCallback } handler - callback of scrollable, + * scrollOffset is offset this frame did scroll, scrollState is current scroll state. + * @returns { GridAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDidScroll(handler: OnScrollCallback): GridAttribute; } /** diff --git a/api/@internal/component/ets/gridItem.d.ts b/api/@internal/component/ets/gridItem.d.ts index 3f6b51c3f778193238bf2c476fad04ca98b63068..bfb75483273e5d351dd0ad6c171063c4dbac34e1 100644 --- a/api/@internal/component/ets/gridItem.d.ts +++ b/api/@internal/component/ets/gridItem.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, Bindable } from './common' +/*** endif */ + /** * Defines the grid item style. * @@ -33,7 +37,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GridItemStyle { /** @@ -49,7 +54,8 @@ declare enum GridItemStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -66,7 +72,8 @@ declare enum GridItemStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAIN = 1, } @@ -86,7 +93,8 @@ declare enum GridItemStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridItemOptions { /** @@ -104,7 +112,8 @@ declare interface GridItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: GridItemStyle; } @@ -131,7 +140,8 @@ declare interface GridItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface GridItemInterface { /** @@ -157,7 +167,8 @@ interface GridItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: GridItemOptions): GridItemAttribute; } @@ -178,7 +189,8 @@ interface GridItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class GridItemAttribute extends CommonMethod { /** @@ -206,7 +218,8 @@ declare class GridItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rowStart(value: number): GridItemAttribute; @@ -235,7 +248,8 @@ declare class GridItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rowEnd(value: number): GridItemAttribute; @@ -264,7 +278,8 @@ declare class GridItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ columnStart(value: number): GridItemAttribute; @@ -293,7 +308,8 @@ declare class GridItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ columnEnd(value: number): GridItemAttribute; @@ -333,7 +349,8 @@ declare class GridItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectable(value: boolean): GridItemAttribute; @@ -360,6 +377,20 @@ declare class GridItemAttribute extends CommonMethod { */ selected(value: boolean): GridItemAttribute; + /** + * Called when judging whether it is selected. + * This parameter supports $$ for two-way binding of variables. + * + * @param { boolean | Bindable } value + * @returns { GridItemAttribute } the attribute of the gridItem. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + selected(value: boolean | Bindable): GridItemAttribute; + /** * Called when the gridItem is selected. * @@ -385,7 +416,8 @@ declare class GridItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onSelect(event: (isSelected: boolean) => void): GridItemAttribute; } diff --git a/api/@internal/component/ets/grid_col.d.ts b/api/@internal/component/ets/grid_col.d.ts index 147401413a5d1d76e374d19dfaeaf91d95c34c91..5889c45d0dd67c30636031d705265532ac774f33 100644 --- a/api/@internal/component/ets/grid_col.d.ts +++ b/api/@internal/component/ets/grid_col.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +/*** endif */ + /** * Defines the option in number unit of grid-container child component. * @@ -43,7 +47,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridColColumnOption { /** @@ -71,7 +76,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xs?: number, @@ -100,7 +106,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sm?: number, @@ -129,7 +136,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ md?: number, @@ -158,7 +166,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lg?: number, @@ -187,7 +196,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xl?: number, @@ -216,7 +226,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xxl?: number, } @@ -246,7 +257,8 @@ declare interface GridColColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridColOptions { /** @@ -274,7 +286,8 @@ declare interface GridColOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ span?: number | GridColColumnOption; @@ -303,7 +316,8 @@ declare interface GridColOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: number | GridColColumnOption; @@ -332,7 +346,8 @@ declare interface GridColOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ order?: number | GridColColumnOption; } @@ -362,7 +377,8 @@ declare interface GridColOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface GridColInterface { /** @@ -393,7 +409,8 @@ interface GridColInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (option?: GridColOptions): GridColAttribute; } @@ -423,7 +440,8 @@ interface GridColInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class GridColAttribute extends CommonMethod { /** @@ -454,7 +472,8 @@ declare class GridColAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ span(value: number | GridColColumnOption): GridColAttribute; @@ -486,7 +505,8 @@ declare class GridColAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ gridColOffset(value: number | GridColColumnOption): GridColAttribute; @@ -518,7 +538,8 @@ declare class GridColAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ order(value: number | GridColColumnOption): GridColAttribute; } diff --git a/api/@internal/component/ets/grid_row.d.ts b/api/@internal/component/ets/grid_row.d.ts index beaa5ea7a4b6601bdcb8cbec1162a6161da24bed..a5ea02dc1072a3a5f2bb8f488f3e56806f6e395b 100644 --- a/api/@internal/component/ets/grid_row.d.ts +++ b/api/@internal/component/ets/grid_row.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ItemAlign } from './enums'; +import { CommonMethod } from './common'; +import { Length } from './units'; +/*** endif */ + /** * Defines the option in length unit of grid-row component. * @@ -43,7 +49,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridRowSizeOption { /** @@ -71,7 +78,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xs?: Length, @@ -100,7 +108,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sm?: Length, @@ -129,7 +138,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ md?: Length, @@ -158,7 +168,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lg?: Length, @@ -187,7 +198,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xl?: Length, @@ -216,7 +228,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xxl?: Length, } @@ -246,7 +259,8 @@ declare interface GridRowSizeOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridRowColumnOption { /** @@ -274,7 +288,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xs?: number, @@ -303,7 +318,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sm?: number, @@ -332,7 +348,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ md?: number, @@ -361,7 +378,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lg?: number, @@ -390,7 +408,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xl?: number, @@ -419,7 +438,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xxl?: number, } @@ -449,7 +469,8 @@ declare interface GridRowColumnOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GutterOption { /** @@ -477,7 +498,8 @@ declare interface GutterOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: Length | GridRowSizeOption, @@ -506,7 +528,8 @@ declare interface GutterOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: Length | GridRowSizeOption } @@ -536,7 +559,8 @@ declare interface GutterOption { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BreakpointsReference { /** @@ -561,7 +585,8 @@ declare enum BreakpointsReference { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ WindowSize, @@ -587,7 +612,8 @@ declare enum BreakpointsReference { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ComponentSize, } @@ -617,7 +643,8 @@ declare enum BreakpointsReference { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum GridRowDirection { /** @@ -642,7 +669,8 @@ declare enum GridRowDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Row, @@ -668,7 +696,8 @@ declare enum GridRowDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RowReverse, } @@ -698,7 +727,8 @@ declare enum GridRowDirection { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BreakPoints { /** @@ -726,7 +756,8 @@ declare interface BreakPoints { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value?: Array, @@ -755,7 +786,8 @@ declare interface BreakPoints { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reference?: BreakpointsReference, } @@ -785,7 +817,8 @@ declare interface BreakPoints { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GridRowOptions { /** @@ -813,7 +846,8 @@ declare interface GridRowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ gutter?: Length | GutterOption; @@ -842,7 +876,8 @@ declare interface GridRowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ columns?: number | GridRowColumnOption; @@ -871,7 +906,8 @@ declare interface GridRowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ breakpoints?: BreakPoints; @@ -900,7 +936,8 @@ declare interface GridRowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: GridRowDirection; } @@ -930,7 +967,8 @@ declare interface GridRowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface GridRowInterface { /** @@ -961,7 +999,8 @@ interface GridRowInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (option?: GridRowOptions): GridRowAttribute; } @@ -991,7 +1030,8 @@ interface GridRowInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class GridRowAttribute extends CommonMethod { /** @@ -1022,7 +1062,8 @@ declare class GridRowAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onBreakpointChange(callback: (breakpoints: string) => void): GridRowAttribute; @@ -1045,7 +1086,8 @@ declare class GridRowAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignItems(value: ItemAlign): GridRowAttribute; } diff --git a/api/@internal/component/ets/hyperlink.d.ts b/api/@internal/component/ets/hyperlink.d.ts index b419b0f2c7fc4dbec09dae9aa5b30c3488a80862..b6afbc3dd1a64d3cd9b33a0c33ce526bd50562d5 100644 --- a/api/@internal/component/ets/hyperlink.d.ts +++ b/api/@internal/component/ets/hyperlink.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from './../../../api/global/resource' +import { CommonMethod } from './common' +import { Color } from './enums' +/*** endif */ + /** * Defines the hyperlink interface. * @@ -31,7 +37,8 @@ * @interface HyperlinkInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface HyperlinkInterface { /** @@ -55,7 +62,8 @@ interface HyperlinkInterface { * @returns { HyperlinkAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (address: string | Resource, content?: string | Resource): HyperlinkAttribute; } @@ -73,7 +81,8 @@ interface HyperlinkInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class HyperlinkAttribute extends CommonMethod { /** @@ -91,7 +100,8 @@ declare class HyperlinkAttribute extends CommonMethod { * @returns { HyperlinkAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color(value: Color | number | string | Resource): HyperlinkAttribute; } diff --git a/api/@internal/component/ets/image.d.ts b/api/@internal/component/ets/image.d.ts index 91556380e156347a24d10ed63159cf1a59deec20..e6263095e9da4b9281bf521b5e4755786a1306b7 100644 --- a/api/@internal/component/ets/image.d.ts +++ b/api/@internal/component/ets/image.d.ts @@ -18,6 +18,19 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import image from '../../@ohos.multimedia.image'; +import drawing from '../../@ohos.graphics.drawing'; +import matrix4 from '../../@ohos.matrix4' +import { BusinessError } from '../../@ohos.base'; +import { DrawableDescriptor } from '../../@ohos.arkui.drawableDescriptor'; +import { ImageAIOptions, ImageAnalyzerConfig } from './imageCommon'; +import { ResourceStr, ResourceColor, ColorFilter, EdgeWidths, ColorMetrics } from './units'; +import { ImageFit, ImageRepeat, CopyOptions } from './enums'; +import { Resource } from '../../global/resource'; +import { CommonMethod, PointLightStyle, PixelMap } from './common' +/*** endif */ + /** * Use the DrawableDescriptor class to get drawable image. * @@ -32,7 +45,7 @@ * @atomicservice * @since 11 */ -declare type DrawableDescriptor = import ('../api/@ohos.arkui.drawableDescriptor').DrawableDescriptor; +declare type DrawableDescriptor = import('../api/@ohos.arkui.drawableDescriptor').DrawableDescriptor; /** * Import the DrawingColorFilter type object for image color filter setting. @@ -45,6 +58,18 @@ declare type DrawableDescriptor = import ('../api/@ohos.arkui.drawableDescriptor */ declare type DrawingColorFilter = import('../api/@ohos.graphics.drawing').default.ColorFilter; +/** + * Import the DrawingColorFilter type object for image color filter setting. + * + * @typedef { drawing.ColorFilter } DrawingColorFilter + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type DrawingColorFilter = drawing.ColorFilter; + /** * Enumerates all the levels available for the image resolution quality. * @@ -53,7 +78,18 @@ declare type DrawingColorFilter = import('../api/@ohos.graphics.drawing').defaul * @systemapi * @since 12 */ -declare type ResolutionQuality = import('../api/@ohos.multimedia.image').default.ResolutionQuality; +declare type ResolutionQuality = import('../api/@ohos.multimedia.image').default.ResolutionQuality; + +/** + * Enumerates all the levels available for the image resolution quality. + * + * @typedef { image.ResolutionQuality } ResolutionQuality + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ +declare type ResolutionQuality = image.ResolutionQuality; /** * Lattice for dividing an image into grids. @@ -64,7 +100,19 @@ declare type ResolutionQuality = import('../api/@ohos.multimedia.image').defaul * @atomicservice * @since 12 */ -declare type DrawingLattice = import('../api/@ohos.graphics.drawing').default.Lattice; +declare type DrawingLattice = import('../api/@ohos.graphics.drawing').default.Lattice; + +/** + * Lattice for dividing an image into grids. + * + * @typedef { drawing.Lattice } DrawingLattice + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type DrawingLattice = drawing.Lattice; /** * Object matrix used for setting image transformations. @@ -75,7 +123,31 @@ declare type DrawingLattice = import('../api/@ohos.graphics.drawing').default.L * @atomicservice * @since 15 */ -declare type ImageMatrix = import ('../api/@ohos.matrix4').default.Matrix4Transit; +declare type ImageMatrix = import('../api/@ohos.matrix4').default.Matrix4Transit; + +/** + * Object matrix used for setting image transformations. + * + * @typedef { matrix4.Matrix4Transit } Matrix4Transit + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type ImageMatrix = matrix4.Matrix4Transit; + +/** + * Business error in onError callback. + * + * @typedef { import('../api/@ohos.base').BusinessError } BusinessError + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +declare type BusinessError = import('../api/@ohos.base').BusinessError; /** * @enum { number } @@ -101,7 +173,8 @@ declare type ImageMatrix = import ('../api/@ohos.matrix4').default.Matrix4Transi * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageRenderMode { /** @@ -132,7 +205,8 @@ declare enum ImageRenderMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Original, @@ -164,7 +238,8 @@ declare enum ImageRenderMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Template, } @@ -177,7 +252,8 @@ declare enum ImageRenderMode { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageContent { /** @@ -187,7 +263,8 @@ declare enum ImageContent { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMPTY = 0, } @@ -196,7 +273,8 @@ declare enum ImageContent { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DynamicRangeMode { /** @@ -204,7 +282,8 @@ declare enum DynamicRangeMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH = 0, @@ -213,7 +292,8 @@ declare enum DynamicRangeMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTRAINT = 1, @@ -222,7 +302,8 @@ declare enum DynamicRangeMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STANDARD = 2, } @@ -251,7 +332,8 @@ declare enum DynamicRangeMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageInterpolation { /** @@ -282,7 +364,8 @@ declare enum ImageInterpolation { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -314,7 +397,8 @@ declare enum ImageInterpolation { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Low, @@ -346,7 +430,8 @@ declare enum ImageInterpolation { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Medium, @@ -378,7 +463,8 @@ declare enum ImageInterpolation { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ High, } @@ -388,7 +474,8 @@ declare enum ImageInterpolation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageRotateOrientation { /** @@ -397,7 +484,8 @@ declare enum ImageRotateOrientation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -407,7 +495,8 @@ declare enum ImageRotateOrientation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ UP = 1, @@ -417,7 +506,8 @@ declare enum ImageRotateOrientation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT = 2, @@ -427,7 +517,8 @@ declare enum ImageRotateOrientation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ DOWN = 3, @@ -437,9 +528,178 @@ declare enum ImageRotateOrientation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ LEFT = 4, + + /** + * Flip the original image horizontally + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + UP_MIRRORED = 5, + + /** + * Flip the original image horizontally and rotate clockwise 90 degrees + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + RIGHT_MIRRORED = 6, + + /** + * Flip the original image vertically + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + DOWN_MIRRORED = 7, + + /** + * Flip the original image horizontally and rotate clockwise 270 degrees + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + LEFT_MIRRORED = 8, +} + +/** + * ImageCompleteEvent + * + * @interface ImageCompleteEvent + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export interface ImageCompleteEvent { + /** + * The width of the image source. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + width: number; + /** + * The height of the image source. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + height: number; + /** + * The width of the component source. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + componentWidth: number; + /** + * The height of the component source. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + componentHeight: number; + /** + * The value of the status of the image being loaded successfully. + * If the returned status value is 0, the image data is successfully loaded. + * If the returned status value is 1, the image is successfully decoded. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + loadingStatus: number; + /** + * The width of the picture that is actually drawn. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + contentWidth: number; + /** + * The height of the picture that is actually drawn. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + contentHeight: number; + /** + * The actual draw is offset from the x-axis of the component itself. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + contentOffsetX: number; + /** + * The actual draw is offset from the y-axis of the component itself. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + contentOffsetY: number; } /** @@ -466,7 +726,8 @@ declare enum ImageRotateOrientation { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImageInterface { /** @@ -518,7 +779,8 @@ interface ImageInterface { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (src: PixelMap | ResourceStr | DrawableDescriptor | ImageContent): ImageAttribute; @@ -530,7 +792,8 @@ interface ImageInterface { * @returns { ImageAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (src: PixelMap | ResourceStr | DrawableDescriptor, imageAIOptions: ImageAIOptions): ImageAttribute; } @@ -543,9 +806,9 @@ interface ImageInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - interface ImageSourceSize { /** * Set width. @@ -581,6 +844,18 @@ interface ImageSourceSize { * @atomicservice * @since 11 */ + /** + * Set width. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ width: number; /** @@ -617,6 +892,18 @@ interface ImageSourceSize { * @atomicservice * @since 11 */ + /** + * Set height. + * Anonymous Object Rectification. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ height: number; } @@ -626,7 +913,8 @@ interface ImageSourceSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ColorContent { /** @@ -638,7 +926,8 @@ declare class ColorContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly ORIGIN: ColorContent; } @@ -667,7 +956,8 @@ declare class ColorContent { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageAttribute extends CommonMethod { /** @@ -717,7 +1007,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alt(value: string | Resource | PixelMap): ImageAttribute; @@ -757,7 +1048,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ matchTextDirection(value: boolean): ImageAttribute; @@ -797,7 +1089,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fitOriginalSize(value: boolean): ImageAttribute; @@ -837,7 +1130,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fillColor(value: ResourceColor): ImageAttribute; @@ -849,10 +1143,24 @@ declare class ImageAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ fillColor(color: ResourceColor | ColorContent): ImageAttribute; + /** + * fill Color + * + * @param { ResourceColor | ColorContent | ColorMetrics } color + * @returns { ImageAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + fillColor(color: ResourceColor | ColorContent | ColorMetrics): ImageAttribute; + /** * Sets the zoom type of an image. * @@ -889,7 +1197,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit(value: ImageFit): ImageAttribute; @@ -901,7 +1210,8 @@ declare class ImageAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ imageMatrix(matrix: ImageMatrix): ImageAttribute; @@ -941,7 +1251,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectRepeat(value: ImageRepeat): ImageAttribute; @@ -981,7 +1292,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ autoResize(value: boolean): ImageAttribute; @@ -1021,7 +1333,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ renderMode(value: ImageRenderMode): ImageAttribute; @@ -1032,7 +1345,8 @@ declare class ImageAttribute extends CommonMethod { * @returns { ImageAttribute } Returns the instance of the ImageAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dynamicRangeMode(value: DynamicRangeMode): ImageAttribute; @@ -1072,7 +1386,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interpolation(value: ImageInterpolation): ImageAttribute; @@ -1121,6 +1436,7 @@ declare class ImageAttribute extends CommonMethod { /** * Specifies the picture decoding size. * The original picture is decoded into a picture of a specified size. The unit of the number type is px. + * Anonymous Object Rectification. * * @param { ImageSourceSize } value - Image source size. * @returns { ImageAttribute } @@ -1128,7 +1444,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sourceSize(value: ImageSourceSize): ImageAttribute; @@ -1172,7 +1489,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ syncLoad(value: boolean): ImageAttribute; @@ -1215,7 +1533,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ colorFilter(value: ColorFilter | DrawingColorFilter): ImageAttribute; @@ -1247,7 +1566,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ copyOption(value: CopyOptions): ImageAttribute; @@ -1279,7 +1599,8 @@ declare class ImageAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ draggable(value: boolean): ImageAttribute; @@ -1290,7 +1611,8 @@ declare class ImageAttribute extends CommonMethod { * @returns { ImageAttribute } The attribute of the image. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pointLight(value: PointLightStyle): ImageAttribute; @@ -1303,7 +1625,8 @@ declare class ImageAttribute extends CommonMethod { * @returns { ImageAttribute } The attribute of the image. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ edgeAntialiasing(value: number): ImageAttribute; @@ -1617,6 +1940,21 @@ declare class ImageAttribute extends CommonMethod { }) => void, ): ImageAttribute; + /** + * This callback is triggered when an image is successfully loaded. + * The size of the image source that is successfully loaded is returned, in pixels. + * + * @param { ImageOnCompleteCallback } callback + * @returns { ImageAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onComplete(callback: ImageOnCompleteCallback): ImageAttribute; + /** * This callback is triggered when an exception occurs during image loading. * The field of "message" carries the detailed information of failed image loading. @@ -1648,7 +1986,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onError(callback: ImageErrorCallback): ImageAttribute; @@ -1692,7 +2031,8 @@ declare class ImageAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish(event: () => void): ImageAttribute; @@ -1711,7 +2051,8 @@ declare class ImageAttribute extends CommonMethod { * @returns { ImageAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAnalyzer(enable: boolean): ImageAttribute; @@ -1722,7 +2063,8 @@ declare class ImageAttribute extends CommonMethod { * @returns { ImageAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ analyzerConfig(config: ImageAnalyzerConfig): ImageAttribute; @@ -1743,7 +2085,8 @@ declare class ImageAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ resizable(value: ResizableOptions): ImageAttribute; @@ -1755,7 +2098,8 @@ declare class ImageAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ privacySensitive(supported: boolean): ImageAttribute; @@ -1766,7 +2110,8 @@ declare class ImageAttribute extends CommonMethod { * @returns { ImageAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enhancedImageQuality(imageQuality: ResolutionQuality): ImageAttribute; @@ -1778,7 +2123,8 @@ declare class ImageAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ orientation(orientation: ImageRotateOrientation) : ImageAttribute; } @@ -1867,10 +2213,25 @@ declare const ImageInstance: ImageAttribute; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type ImageErrorCallback = (error: ImageError) => void; +/** + * ImageOnCompleteCallback + * + * @typedef { function } ImageOnCompleteCallback + * @param { ImageCompleteEvent } loadEvent + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +type ImageOnCompleteCallback = (loadEvent?: ImageCompleteEvent) => void; + /** * @interface ImageError * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -1890,7 +2251,8 @@ type ImageErrorCallback = (error: ImageError) => void; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ImageError { /** @@ -1918,7 +2280,8 @@ declare interface ImageError { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ componentWidth: number; @@ -1947,7 +2310,8 @@ declare interface ImageError { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ componentHeight: number; @@ -1968,9 +2332,23 @@ declare interface ImageError { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + message: string; + + /** + * Error code. + * + * @type { ?BusinessError } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 */ - message: string + error?: BusinessError; } /** @@ -1988,7 +2366,8 @@ declare interface ImageError { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ResizableOptions { /** @@ -2006,7 +2385,8 @@ declare interface ResizableOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ slice?: EdgeWidths; @@ -2017,7 +2397,8 @@ declare interface ResizableOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lattice?: DrawingLattice; } diff --git a/api/@internal/component/ets/image_animator.d.ts b/api/@internal/component/ets/image_animator.d.ts index 20e66c9792e8d697e2de9bbb697810f460f07a98..85d0c53a2649e85f1643fa01f8bd9e24f9775e95 100644 --- a/api/@internal/component/ets/image_animator.d.ts +++ b/api/@internal/component/ets/image_animator.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from "../../global/resource"; +import image from '../../@ohos.multimedia.image' +import { CommonMethod, PixelMap } from './common' +import { AnimationStatus,FillMode } from './enums' +/*** endif */ + /** * Defines the ImageAnimator Interface. * @@ -42,7 +49,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImageAnimatorInterface { /** @@ -69,7 +77,8 @@ interface ImageAnimatorInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): ImageAnimatorAttribute; } @@ -98,7 +107,8 @@ interface ImageAnimatorInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImageFrameInfo { /** @@ -142,9 +152,11 @@ interface ImageFrameInfo { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ src: string | Resource | PixelMap; + /** * Image width * @@ -169,7 +181,8 @@ interface ImageFrameInfo { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: number | string; /** @@ -196,7 +209,8 @@ interface ImageFrameInfo { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number | string; /** @@ -223,7 +237,8 @@ interface ImageFrameInfo { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: number | string; /** @@ -250,7 +265,8 @@ interface ImageFrameInfo { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: number | string; /** @@ -275,7 +291,8 @@ interface ImageFrameInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; } @@ -304,7 +321,8 @@ interface ImageFrameInfo { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageAnimatorAttribute extends CommonMethod { /** @@ -334,7 +352,8 @@ declare class ImageAnimatorAttribute extends CommonMethod): ImageAnimatorAttribute; @@ -365,7 +384,8 @@ declare class ImageAnimatorAttribute extends CommonMethod void): ImageAnimatorAttribute; @@ -603,7 +630,8 @@ declare class ImageAnimatorAttribute extends CommonMethod void): ImageAnimatorAttribute; @@ -632,7 +660,8 @@ declare class ImageAnimatorAttribute extends CommonMethod void): ImageAnimatorAttribute; @@ -663,7 +692,8 @@ declare class ImageAnimatorAttribute extends CommonMethod void): ImageAnimatorAttribute; @@ -694,7 +724,8 @@ declare class ImageAnimatorAttribute extends CommonMethod void): ImageAnimatorAttribute; } diff --git a/api/@internal/component/ets/image_common.d.ts b/api/@internal/component/ets/image_common.d.ts index ad4c5d95770ca982a9dbbbc1b788ace434892222..dd1e0209055094c48d055aa69d61e70e336f7aee 100644 --- a/api/@internal/component/ets/image_common.d.ts +++ b/api/@internal/component/ets/image_common.d.ts @@ -24,7 +24,8 @@ * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ImageAnalyzerType { /** @@ -32,7 +33,8 @@ declare enum ImageAnalyzerType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBJECT = 0, @@ -41,7 +43,8 @@ declare enum ImageAnalyzerType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT, @@ -50,7 +53,8 @@ declare enum ImageAnalyzerType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OBJECT_LOOKUP, } @@ -60,7 +64,8 @@ declare enum ImageAnalyzerType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageAnalyzerController { /** @@ -68,7 +73,8 @@ declare class ImageAnalyzerController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -78,7 +84,8 @@ declare class ImageAnalyzerController { * @returns { ImageAnalyzerType[] } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getImageAnalyzerSupportTypes(): ImageAnalyzerType[]; } @@ -89,7 +96,8 @@ declare class ImageAnalyzerController { * @interface ImageAnalyzerConfig * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ImageAnalyzerConfig { /** @@ -98,7 +106,8 @@ declare interface ImageAnalyzerConfig { * @type { ImageAnalyzerType[] } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ types: ImageAnalyzerType[]; } @@ -109,7 +118,8 @@ declare interface ImageAnalyzerConfig { * @interface ImageAIOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ImageAIOptions { /** @@ -118,7 +128,8 @@ declare interface ImageAIOptions { * @type { ?ImageAnalyzerType[] } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ types?: ImageAnalyzerType[]; @@ -128,7 +139,8 @@ declare interface ImageAIOptions { * @type { ?ImageAnalyzerController } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ aiController?: ImageAnalyzerController; -} \ No newline at end of file +} diff --git a/api/@internal/component/ets/image_span.d.ts b/api/@internal/component/ets/image_span.d.ts index 40109b352aff809c0bbcaec6101689cdf5ef2e42..3bce91cbbca0dbd9cd51514addd6172d423cc404 100644 --- a/api/@internal/component/ets/image_span.d.ts +++ b/api/@internal/component/ets/image_span.d.ts @@ -18,6 +18,15 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceStr, ColorFilter} from './units'; +import { BaseSpan } from './span'; +import { ImageSpanAlignment, ImageFit } from './enums'; +import { ImageErrorCallback } from './image'; +import { PixelMap } from './common'; +import image from '../../@ohos.multimedia.image'; +/*** endif */ + /** * Provide image decoration in the text component. * @@ -33,7 +42,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImageSpanInterface { /** @@ -53,7 +63,8 @@ interface ImageSpanInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: ResourceStr | PixelMap): ImageSpanAttribute; } @@ -73,7 +84,8 @@ interface ImageSpanInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageSpanAttribute extends BaseSpan { /** @@ -93,7 +105,8 @@ declare class ImageSpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ verticalAlign(value: ImageSpanAlignment): ImageSpanAttribute; @@ -126,7 +139,8 @@ declare class ImageSpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit(value: ImageFit): ImageSpanAttribute; @@ -139,7 +153,8 @@ declare class ImageSpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onComplete(callback: ImageCompleteCallback): ImageSpanAttribute; @@ -152,7 +167,8 @@ declare class ImageSpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onError(callback: ImageErrorCallback): ImageSpanAttribute; @@ -163,7 +179,8 @@ declare class ImageSpanAttribute extends BaseSpan { * @returns { ImageSpanAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alt(value: PixelMap): ImageSpanAttribute; } @@ -210,7 +227,8 @@ declare const ImageSpanInstance: ImageSpanAttribute; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type ImageCompleteCallback = (result: ImageLoadResult) => void; @@ -221,7 +239,8 @@ type ImageCompleteCallback = (result: ImageLoadResult) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ImageLoadResult { /** @@ -231,7 +250,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; /** @@ -241,7 +261,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; /** @@ -251,7 +272,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ componentWidth: number; /** @@ -261,7 +283,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ componentHeight: number; /** @@ -273,7 +296,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ loadingStatus: number; /** @@ -283,7 +307,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentWidth: number; /** @@ -293,7 +318,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentHeight: number; /** @@ -303,7 +329,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentOffsetX: number; /** @@ -313,7 +340,8 @@ declare interface ImageLoadResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentOffsetY: number; } diff --git a/api/@internal/component/ets/indicatorcomponent.d.ts b/api/@internal/component/ets/indicatorcomponent.d.ts index 88e13f3b95623c813f011f370ef686e72c5b38ef..fea813bcc067cc81fec075831ffdb0b7a5f51430 100644 --- a/api/@internal/component/ets/indicatorcomponent.d.ts +++ b/api/@internal/component/ets/indicatorcomponent.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, Callback } from './common'; +import { DotIndicator, DigitIndicator } from './swiper'; +/*** endif */ + /** * Provides methods for switching components. * @@ -25,7 +30,8 @@ * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare class IndicatorComponentController { /** @@ -35,7 +41,8 @@ declare class IndicatorComponentController { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -46,7 +53,8 @@ declare class IndicatorComponentController { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ showNext():void; @@ -57,7 +65,8 @@ declare class IndicatorComponentController { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ showPrevious():void; @@ -71,7 +80,8 @@ declare class IndicatorComponentController { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ changeIndex(index: number, useAnimation?: boolean):void; } @@ -84,7 +94,8 @@ declare class IndicatorComponentController { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface IndicatorComponentInterface { @@ -97,7 +108,8 @@ interface IndicatorComponentInterface { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ (controller?: IndicatorComponentController): IndicatorComponentAttribute; } @@ -110,7 +122,8 @@ interface IndicatorComponentInterface { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare class IndicatorComponentAttribute extends CommonMethod { /** @@ -122,7 +135,8 @@ declare class IndicatorComponentAttribute extends CommonMethod): IndicatorComponentAttribute; } diff --git a/api/@internal/component/ets/inspector.d.ts b/api/@internal/component/ets/inspector.d.ts index aa2ba50e3704331504b3fe8e50aa19cd802708ed..b5ba36dd3842a5a346836d58a3f01a29d900478b 100644 --- a/api/@internal/component/ets/inspector.d.ts +++ b/api/@internal/component/ets/inspector.d.ts @@ -49,8 +49,9 @@ declare function getInspectorNodeById(id: number): object; * @namespace Profiler * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} * @test + * @arkts 1.1&1.2 */ declare namespace Profiler { /** @@ -59,8 +60,9 @@ declare namespace Profiler { * @param { function } callback - the callback info is json string with ui update info. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} * @test + * @arkts 1.1&1.2 */ function registerVsyncCallback(callback: (info: string) => void): void; @@ -69,8 +71,9 @@ declare namespace Profiler { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} * @test + * @arkts 1.1&1.2 */ function unregisterVsyncCallback(): void; } @@ -81,7 +84,8 @@ declare namespace Profiler { * @param { string } value * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} * @test + * @arkts 1.1&1.2 */ declare function setAppBgColor(value: string): void; diff --git a/api/@internal/component/ets/line.d.ts b/api/@internal/component/ets/line.d.ts index 29245a77bdb934c6b3dc60afcbd58c1c42fa29be..793e84d424bd1f9772cbca2c804bb9a7ceb36481 100644 --- a/api/@internal/component/ets/line.d.ts +++ b/api/@internal/component/ets/line.d.ts @@ -18,6 +18,24 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonShapeMethod, CommonMethod } from './common'; +import { Length } from './units'; +/*** endif */ + +/** + * Defines the Shape Point, the first element is the x-axis offset and the second is the y-axis. + * + * @typedef { [Length, Length] } ShapePoint + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export type ShapePoint = [Length, Length]; + /** * Defines Line constructor options. * @@ -26,7 +44,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface LineOptions { /** @@ -61,7 +80,8 @@ interface LineOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: string | number; @@ -97,7 +117,8 @@ interface LineOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: string | number; } @@ -288,7 +309,8 @@ interface LineInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LineAttribute extends CommonShapeMethod { /** @@ -331,6 +353,20 @@ declare class LineAttribute extends CommonShapeMethod { */ startPoint(value: Array): LineAttribute; + /** + * Coordinate of the start point of the line (relative coordinate). + * + * @param { ShapePoint } value + * @returns { LineAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + startPoint(value: ShapePoint): LineAttribute; + /** * Line end coordinates (relative coordinates). * @@ -370,6 +406,20 @@ declare class LineAttribute extends CommonShapeMethod { * @since 11 */ endPoint(value: Array): LineAttribute; + + /** + * Line end coordinates (relative coordinates). + * + * @param { ShapePoint } value + * @returns { LineAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + endPoint(value: ShapePoint): LineAttribute; } /** @@ -435,3 +485,30 @@ declare const Line: LineInterface; * @since 11 */ declare const LineInstance: LineAttribute; + +/** + * Line drawing component. + * + * @interface LineInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface LineInterface { + /** + * The return value of the parameter is Line. + * + * @param { LineOptions } [options] - Line options + * @returns { LineAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options?: LineOptions): LineAttribute; +} diff --git a/api/@internal/component/ets/linearindicator.d.ts b/api/@internal/component/ets/linearindicator.d.ts index 879083cf95bf9b58094526e20f389776005193f5..3b548b466ad7aebae21832188fbfcc8f5b5b2360 100644 --- a/api/@internal/component/ets/linearindicator.d.ts +++ b/api/@internal/component/ets/linearindicator.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, Optional } from './common'; +import { ColorMetrics, LengthMetrics } from './units'; +/*** endif */ + /** * Defines the LinearIndicator Controller. * @@ -25,7 +30,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LinearIndicatorController { /** @@ -34,7 +40,8 @@ declare class LinearIndicatorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -48,7 +55,8 @@ declare class LinearIndicatorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ setProgress(index: number, progress: number): void; @@ -59,7 +67,8 @@ declare class LinearIndicatorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ start(options?: LinearIndicatorStartOptions): void; @@ -70,7 +79,8 @@ declare class LinearIndicatorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ pause(): void; @@ -81,7 +91,8 @@ declare class LinearIndicatorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stop(): void; } @@ -93,7 +104,8 @@ declare class LinearIndicatorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LinearIndicatorStartOptions { /** @@ -104,7 +116,8 @@ declare interface LinearIndicatorStartOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interval?: number; @@ -116,7 +129,8 @@ declare interface LinearIndicatorStartOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; } @@ -128,7 +142,8 @@ declare interface LinearIndicatorStartOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LinearIndicatorStyle { /** @@ -139,7 +154,8 @@ declare interface LinearIndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ space?: LengthMetrics; @@ -151,7 +167,8 @@ declare interface LinearIndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: LengthMetrics; @@ -163,7 +180,8 @@ declare interface LinearIndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ strokeRadius?: LengthMetrics; @@ -175,7 +193,8 @@ declare interface LinearIndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ trackBackgroundColor?: ColorMetrics; @@ -187,7 +206,8 @@ declare interface LinearIndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ trackColor?: ColorMetrics; } @@ -199,7 +219,8 @@ declare interface LinearIndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface LinearIndicatorInterface { /** @@ -212,7 +233,8 @@ interface LinearIndicatorInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (count?: number, controller?: LinearIndicatorController): LinearIndicatorAttribute; } @@ -224,7 +246,8 @@ interface LinearIndicatorInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LinearIndicatorAttribute extends CommonMethod { /** @@ -235,7 +258,8 @@ declare class LinearIndicatorAttribute extends CommonMethod): LinearIndicatorAttribute; @@ -247,7 +271,8 @@ declare class LinearIndicatorAttribute extends CommonMethod): LinearIndicatorAttribute; @@ -259,7 +284,8 @@ declare class LinearIndicatorAttribute extends CommonMethod): LinearIndicatorAttribute; } @@ -273,7 +299,8 @@ declare class LinearIndicatorAttribute extends CommonMethod void; diff --git a/api/@internal/component/ets/list.d.ts b/api/@internal/component/ets/list.d.ts index 18bfbbdedaa2824343496cf5759c1f1d14228ced..bfcab63d3ec924574bc94a76d6b90be80d3979f9 100644 --- a/api/@internal/component/ets/list.d.ts +++ b/api/@internal/component/ets/list.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * 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 @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ChildrenMainSize, ItemDragInfo, RectResult, ScrollableCommonMethod, Optional, + OnWillScrollCallback, OnScrollCallback, OnItemDragStartCallback } from './common'; +import { Axis } from './enums'; +import { OnScrollFrameBeginCallback, ScrollAlign, Scroller } from './scroll'; +import { Dimension, Length, LengthConstrain, ResourceColor } from './units'; +/*** endif */ + /** * Declare scroll status * @@ -50,7 +58,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollState { /** @@ -81,7 +90,8 @@ declare enum ScrollState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Idle, @@ -113,7 +123,8 @@ declare enum ScrollState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Scroll, @@ -145,7 +156,8 @@ declare enum ScrollState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Fling, } @@ -175,7 +187,8 @@ declare enum ScrollState { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ListItemAlign { /** @@ -200,7 +213,8 @@ declare enum ListItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -226,7 +240,8 @@ declare enum ListItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Center, @@ -252,7 +267,8 @@ declare enum ListItemAlign { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, } @@ -264,7 +280,8 @@ declare enum ListItemAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ListItemGroupArea { /** @@ -273,7 +290,8 @@ declare enum ListItemGroupArea { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -283,7 +301,8 @@ declare enum ListItemGroupArea { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IN_LIST_ITEM_AREA = 1, @@ -293,7 +312,8 @@ declare enum ListItemGroupArea { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IN_HEADER_AREA = 2, @@ -303,7 +323,8 @@ declare enum ListItemGroupArea { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IN_FOOTER_AREA = 3, } @@ -333,7 +354,8 @@ declare enum ListItemGroupArea { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum StickyStyle { /** @@ -358,7 +380,8 @@ declare enum StickyStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None = 0, @@ -384,7 +407,8 @@ declare enum StickyStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Header = 1, @@ -410,7 +434,8 @@ declare enum StickyStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Footer = 2, } @@ -421,7 +446,8 @@ declare enum StickyStyle { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ChainEdgeEffect { /** @@ -430,7 +456,8 @@ declare enum ChainEdgeEffect { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT, @@ -439,7 +466,8 @@ declare enum ChainEdgeEffect { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ STRETCH, } @@ -458,7 +486,8 @@ declare enum ChainEdgeEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollSnapAlign { /** @@ -475,7 +504,8 @@ declare enum ScrollSnapAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE, @@ -491,7 +521,8 @@ declare enum ScrollSnapAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START, @@ -507,7 +538,8 @@ declare enum ScrollSnapAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER, @@ -523,7 +555,8 @@ declare enum ScrollSnapAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END, } @@ -534,7 +567,8 @@ declare enum ScrollSnapAlign { * @interface ChainAnimationOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ChainAnimationOptions { /** @@ -543,7 +577,8 @@ declare interface ChainAnimationOptions { * @type { Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ minSpace: Length; @@ -553,7 +588,8 @@ declare interface ChainAnimationOptions { * @type { Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ maxSpace: Length; @@ -564,7 +600,8 @@ declare interface ChainAnimationOptions { * @default 0.7 * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ conductivity?: number; @@ -575,7 +612,8 @@ declare interface ChainAnimationOptions { * @default 0.3 * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ intensity?: number; @@ -586,7 +624,8 @@ declare interface ChainAnimationOptions { * @default ChainEdgeEffect.DEFAULT * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ edgeEffect?: ChainEdgeEffect; @@ -597,7 +636,8 @@ declare interface ChainAnimationOptions { * @default 228 * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ stiffness?: number; @@ -608,7 +648,8 @@ declare interface ChainAnimationOptions { * @default 30 * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ damping?: number; } @@ -628,7 +669,8 @@ declare interface ChainAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CloseSwipeActionOptions { /** @@ -646,7 +688,8 @@ declare interface CloseSwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish?: ()=>void } @@ -658,7 +701,8 @@ declare interface CloseSwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface VisibleListContentInfo { /** @@ -668,7 +712,8 @@ declare interface VisibleListContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number @@ -679,7 +724,8 @@ declare interface VisibleListContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ itemGroupArea?: ListItemGroupArea @@ -690,7 +736,8 @@ declare interface VisibleListContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ itemIndexInGroup?: number } @@ -702,7 +749,8 @@ declare interface VisibleListContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnScrollVisibleContentChangeCallback = (start: VisibleListContentInfo, end: VisibleListContentInfo) => void; @@ -717,7 +765,8 @@ declare type OnScrollVisibleContentChangeCallback = (start: VisibleListContentIn * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ListScroller extends Scroller { /** @@ -749,7 +798,8 @@ declare class ListScroller extends Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getItemRectInGroup(index: number, indexInGroup: number): RectResult; @@ -784,7 +834,8 @@ declare class ListScroller extends Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scrollToItemInGroup(index: number, indexInGroup:number, smooth?: boolean, align?: ScrollAlign): void; @@ -813,7 +864,8 @@ declare class ListScroller extends Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ closeAllSwipeActions(options?: CloseSwipeActionOptions): void; @@ -831,7 +883,8 @@ declare class ListScroller extends Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getVisibleListContentInfo(x: number, y: number): VisibleListContentInfo; } @@ -844,7 +897,8 @@ declare class ListScroller extends Scroller { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface ListOptions { /** @@ -879,7 +933,8 @@ interface ListOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ initialIndex?: number; /** @@ -914,7 +969,8 @@ interface ListOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ space?: number | string; /** @@ -949,7 +1005,8 @@ interface ListOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scroller?: Scroller; } @@ -986,7 +1043,8 @@ interface ListOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ListInterface { /** @@ -1036,7 +1094,8 @@ interface ListInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: ListOptions): ListAttribute; } @@ -1049,7 +1108,8 @@ interface ListInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ListDividerOptions { /** @@ -1084,7 +1144,8 @@ declare interface ListDividerOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth: Length; /** @@ -1119,7 +1180,8 @@ declare interface ListDividerOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; /** @@ -1154,7 +1216,8 @@ declare interface ListDividerOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startMargin?: Length; /** @@ -1189,7 +1252,8 @@ declare interface ListDividerOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endMargin?: Length; } @@ -1218,7 +1282,8 @@ declare interface ListDividerOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ListAttribute extends ScrollableCommonMethod { /** @@ -1251,7 +1316,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lanes(value: number | LengthConstrain, gutter?: Dimension): ListAttribute; @@ -1283,7 +1349,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignListItem(value: ListItemAlign): ListAttribute; @@ -1323,7 +1390,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ listDirection(value: Axis): ListAttribute; @@ -1423,7 +1491,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentStartOffset(value: number): ListAttribute; @@ -1442,7 +1511,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentEndOffset(value: number): ListAttribute; @@ -1493,7 +1563,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ divider( value: ListDividerOptions | null, @@ -1546,7 +1617,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ multiSelectable(value: boolean): ListAttribute; @@ -1586,7 +1658,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cachedCount(value: number): ListAttribute; @@ -1600,7 +1673,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ cachedCount(count: number, show: boolean): ListAttribute; @@ -1640,7 +1714,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ chainAnimation(value: boolean): ListAttribute; @@ -1651,7 +1726,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @returns { ListAttribute } the attribute of the list. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ chainAnimationOptions(value: ChainAnimationOptions): ListAttribute; @@ -1683,7 +1759,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sticky(value: StickyStyle): ListAttribute; @@ -1703,7 +1780,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollSnapAlign(value: ScrollSnapAlign): ListAttribute; @@ -1777,7 +1855,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ childrenMainSize(value: ChildrenMainSize): ListAttribute; @@ -1789,7 +1868,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maintainVisibleContentPosition(enabled: boolean): ListAttribute; @@ -1801,7 +1881,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stackFromEnd(enabled: boolean): ListAttribute; @@ -1883,7 +1964,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollIndex(event: (start: number, end: number, center: number) => void): ListAttribute; @@ -1895,7 +1977,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollVisibleContentChange(handler: OnScrollVisibleContentChangeCallback): ListAttribute; @@ -2087,7 +2170,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemMove(event: (from: number, to: number) => boolean): ListAttribute; @@ -2123,6 +2207,19 @@ declare class ListAttribute extends ScrollableCommonMethod { */ onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => ((() => any) | void)): ListAttribute; + /** + * After a listener is bound, the component can be dragged. After the drag occurs, a callback is triggered. + * (To be triggered, press and hold for 170 milliseconds (ms)) + * + * @param { OnItemDragStartCallback } event - callback function, triggered when the item drag start. + * @returns { ListAttribute } Returns the instance of the ListAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onItemDragStart(event: OnItemDragStartCallback): ListAttribute; + /** * After binding, a callback is triggered when the component is dragged to the range of the component. * @@ -2148,7 +2245,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDragEnter(event: (event: ItemDragInfo) => void): ListAttribute; @@ -2177,7 +2275,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void): ListAttribute; @@ -2206,7 +2305,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void): ListAttribute; @@ -2238,7 +2338,8 @@ declare class ListAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void): ListAttribute; @@ -2272,7 +2373,46 @@ declare class ListAttribute extends ScrollableCommonMethod { * @atomicservice * @since 11 */ - onScrollFrameBegin(event: (offset: number, state: ScrollState) => { offsetRemain: number }): ListAttribute; + /** + * Called when scrolling begin each frame. + * Anonymous Object Rectification. + * + * @param { OnScrollFrameBeginCallback } event - callback function, triggered when the scrolling begin each frame. + * @returns { ListAttribute } Returns the instance of the ListAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + onScrollFrameBegin(event: OnScrollFrameBeginCallback): ListAttribute; + + /** + * Called when the scrollable will scroll. + * + * @param { Optional } handler - callback of scrollable. + * @returns { ListAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onWillScroll(handler: Optional): ListAttribute; + + /** + * Called when the scrollable did scroll. + * + * @param { OnScrollCallback } handler - callback of scrollable, + * scrollOffset is offset this frame did scroll, scrollState is current scroll state. + * @returns { ListAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDidScroll(handler: OnScrollCallback): ListAttribute; } /** diff --git a/api/@internal/component/ets/list_item.d.ts b/api/@internal/component/ets/list_item.d.ts index ae66c200dc373eae80da40e21983066e76c1ecf8..e5149aa59394752370a561abfd186574be56dfe6 100644 --- a/api/@internal/component/ets/list_item.d.ts +++ b/api/@internal/component/ets/list_item.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * 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 @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +import { CustomBuilder } from './builder' +import { Length } from './units'; +import { ComponentContent } from '../ComponentContent' +/*** endif */ + /** * Declare item ceiling attribute. * @@ -115,7 +122,8 @@ declare enum EditMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SwipeEdgeEffect { /** @@ -137,7 +145,8 @@ declare enum SwipeEdgeEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Spring, @@ -160,7 +169,8 @@ declare enum SwipeEdgeEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -180,7 +190,8 @@ declare enum SwipeEdgeEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SwipeActionState { /** @@ -194,7 +205,8 @@ declare enum SwipeActionState { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COLLAPSED, @@ -209,7 +221,8 @@ declare enum SwipeActionState { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPANDED, @@ -224,7 +237,8 @@ declare enum SwipeActionState { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ACTIONING, } @@ -243,7 +257,8 @@ declare enum SwipeActionState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwipeActionItem { /** @@ -262,7 +277,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ builder?: CustomBuilder; @@ -274,7 +290,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ builderComponent?: ComponentContent; @@ -294,7 +311,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ actionAreaDistance?: Length; @@ -312,7 +330,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAction?: () => void; @@ -330,7 +349,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onEnterActionArea?: () => void; @@ -348,7 +368,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onExitActionArea?: () => void; @@ -367,7 +388,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onStateChange?: (state: SwipeActionState) => void; } @@ -394,7 +416,8 @@ declare interface SwipeActionItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwipeActionOptions { /** @@ -422,7 +445,8 @@ declare interface SwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ start?: CustomBuilder | SwipeActionItem; @@ -451,7 +475,8 @@ declare interface SwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ end?: CustomBuilder | SwipeActionItem; @@ -477,7 +502,8 @@ declare interface SwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ edgeEffect?: SwipeEdgeEffect; @@ -496,7 +522,8 @@ declare interface SwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onOffsetChange?: (offset: number) => void; } @@ -515,7 +542,8 @@ declare interface SwipeActionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ListItemStyle { /** @@ -530,7 +558,8 @@ declare enum ListItemStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -546,7 +575,8 @@ declare enum ListItemStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CARD = 1, } @@ -565,7 +595,8 @@ declare enum ListItemStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ListItemOptions { /** @@ -582,7 +613,8 @@ declare interface ListItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: ListItemStyle; } @@ -619,7 +651,8 @@ declare interface ListItemOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ListItemInterface { /** @@ -641,7 +674,8 @@ interface ListItemInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: ListItemOptions): ListItemAttribute; @@ -691,7 +725,8 @@ interface ListItemInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ListItemAttribute extends CommonMethod { /** @@ -753,7 +788,8 @@ declare class ListItemAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectable(value: boolean): ListItemAttribute; @@ -778,7 +814,8 @@ declare class ListItemAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selected(value: boolean): ListItemAttribute; @@ -807,7 +844,8 @@ declare class ListItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ swipeAction(value: SwipeActionOptions): ListItemAttribute; @@ -847,7 +885,8 @@ declare class ListItemAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onSelect(event: (isSelected: boolean) => void): ListItemAttribute; } diff --git a/api/@internal/component/ets/list_item_group.d.ts b/api/@internal/component/ets/list_item_group.d.ts index 0e2a3a86ab32198b211dd7c56926bf0a9b818c69..d50bb67aa79d685c5e72de79997678d111f58761 100644 --- a/api/@internal/component/ets/list_item_group.d.ts +++ b/api/@internal/component/ets/list_item_group.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2023 Huawei Device Co., Ltd. + * Copyright (c) 2022-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 @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ChildrenMainSize, CommonMethod } from './common'; +import { CustomBuilder } from './builder' +import { ComponentContent } from '../ComponentContent' +import { ListDividerOptions } from './list'; +/*** endif */ + /** * Defines the list item group style. * @@ -32,7 +39,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ListItemGroupStyle { /** @@ -47,7 +55,8 @@ declare enum ListItemGroupStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -63,7 +72,8 @@ declare enum ListItemGroupStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CARD = 1, } @@ -90,7 +100,8 @@ declare enum ListItemGroupStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ListItemGroupOptions { /** @@ -115,7 +126,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ header?: CustomBuilder; @@ -126,7 +138,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ headerComponent?: ComponentContent; @@ -152,7 +165,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ footer?: CustomBuilder; @@ -163,7 +177,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ footerComponent?: ComponentContent; @@ -189,7 +204,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ space?: number | string; @@ -207,7 +223,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: ListItemGroupStyle; } @@ -234,7 +251,8 @@ declare interface ListItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ListItemGroupInterface { /** @@ -262,7 +280,8 @@ interface ListItemGroupInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: ListItemGroupOptions): ListItemGroupAttribute; } @@ -289,7 +308,8 @@ interface ListItemGroupInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ListItemGroupAttribute extends CommonMethod { /** @@ -342,7 +362,8 @@ declare class ListItemGroupAttribute extends CommonMethod { /** @@ -293,7 +305,8 @@ declare class LoadingProgressAttribute extends CommonMethod): LoadingProgressAttribute; } @@ -339,7 +354,8 @@ declare class LoadingProgressAttribute extends CommonMethod { /** @@ -349,7 +365,8 @@ declare interface LoadingProgressConfiguration extends CommonConfiguration { /** @@ -368,7 +384,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): MarqueeAttribute; @@ -408,7 +425,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Length): MarqueeAttribute; @@ -448,7 +466,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ allowScale(value: boolean): MarqueeAttribute; @@ -488,7 +507,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): MarqueeAttribute; @@ -528,7 +548,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: string | Resource): MarqueeAttribute; @@ -540,7 +561,8 @@ declare class MarqueeAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ marqueeUpdateStrategy(value: MarqueeUpdateStrategy): MarqueeAttribute; @@ -580,7 +602,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onStart(event: () => void): MarqueeAttribute; @@ -620,7 +643,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onBounce(event: () => void): MarqueeAttribute; @@ -660,7 +684,8 @@ declare class MarqueeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish(event: () => void): MarqueeAttribute; } diff --git a/api/@internal/component/ets/matrix2d.d.ts b/api/@internal/component/ets/matrix2d.d.ts index 594e7dc4e95d61c89672e5ad35dc8fb12201d0d5..a0378005cc60e1bfdce048b0084f3a15ad0d3d25 100644 --- a/api/@internal/component/ets/matrix2d.d.ts +++ b/api/@internal/component/ets/matrix2d.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { LengthMetricsUnit } from '../Graphics'; +/*** endif */ + /** * 2D transformation matrix, supporting rotation, translation, and scaling of the X-axis and Y-axis * @@ -46,7 +50,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class Matrix2D { /** @@ -81,7 +86,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scaleX?: number; @@ -117,7 +123,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotateY?: number; @@ -153,7 +160,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotateX?: number; @@ -189,7 +197,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scaleY?: number; @@ -225,7 +234,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ translateX?: number; @@ -261,7 +271,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ translateY?: number; @@ -301,7 +312,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ identity(): Matrix2D; @@ -341,7 +353,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ invert(): Matrix2D; @@ -413,7 +426,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotate(degree: number, rx?: number, ry?: number): Matrix2D; @@ -457,7 +471,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ translate(tx?: number, ty?: number): Matrix2D; @@ -501,7 +516,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scale(sx?: number, sy?: number): Matrix2D; @@ -520,7 +536,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -532,7 +549,8 @@ declare class Matrix2D { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(unit: LengthMetricsUnit); } diff --git a/api/@internal/component/ets/media_cached_image.d.ts b/api/@internal/component/ets/media_cached_image.d.ts index 70b0546afbc3add213b1b476eb2c70ee883b9a0d..4a20ef46d6b456ce808e2110e72fd041353d73bb 100644 --- a/api/@internal/component/ets/media_cached_image.d.ts +++ b/api/@internal/component/ets/media_cached_image.d.ts @@ -17,14 +17,20 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { ImageAttribute } from './image'; +import image from '../../@ohos.multimedia.image'; +import { ResourceStr } from './units' +import { DrawableDescriptor } from '../../@ohos.arkui.drawableDescriptor'; +/*** endif */ /** * Defines the resource which can use ASTC. * * @interface ASTCResource * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ASTCResource { /** @@ -32,7 +38,8 @@ interface ASTCResource { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sources: Array; /** @@ -40,7 +47,8 @@ interface ASTCResource { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ column: number; } @@ -49,7 +57,8 @@ interface ASTCResource { * @interface MediaCachedImageInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface MediaCachedImageInterface { /** @@ -62,6 +71,17 @@ interface MediaCachedImageInterface { * @since 12 */ (src: PixelMap | ResourceStr | DrawableDescriptor | ASTCResource): MediaCachedImageAttribute; + /** + * Image resource to be obtained. + * + * @param { PixelMap | ResourceStr | DrawableDescriptor | ASTCResource } src + * @returns { MediaCachedImageAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + (src: image.PixelMap | ResourceStr | DrawableDescriptor | ASTCResource): MediaCachedImageAttribute; } /** @@ -70,7 +90,8 @@ interface MediaCachedImageInterface { * @extends ImageAttribute * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class MediaCachedImageAttribute extends ImageAttribute {} diff --git a/api/@internal/component/ets/menu.d.ts b/api/@internal/component/ets/menu.d.ts index 8d3f144a1e536d37efe00ea889b76655454db1fa..41928a50f65fd2b41573c9921e77abf7efa7e603 100644 --- a/api/@internal/component/ets/menu.d.ts +++ b/api/@internal/component/ets/menu.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +import { Length, Font, ResourceColor, Dimension, BorderRadiuses, DividerStyleOptions } from './units'; +/*** endif */ + /** * Defines the Menu Component. * @@ -40,7 +45,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface MenuInterface { /** @@ -65,7 +71,8 @@ interface MenuInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): MenuAttribute; } @@ -77,7 +84,8 @@ interface MenuInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SubMenuExpandingMode { /** @@ -86,7 +94,8 @@ declare enum SubMenuExpandingMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SIDE_EXPAND = 0, @@ -96,7 +105,8 @@ declare enum SubMenuExpandingMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED_EXPAND = 1, @@ -106,7 +116,8 @@ declare enum SubMenuExpandingMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STACK_EXPAND = 2, } @@ -133,7 +144,8 @@ declare enum SubMenuExpandingMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class MenuAttribute extends CommonMethod { /** @@ -167,7 +179,8 @@ declare class MenuAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ font(value: Font): MenuAttribute; @@ -188,7 +201,8 @@ declare class MenuAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): MenuAttribute; @@ -211,7 +225,8 @@ declare class MenuAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radius(value: Dimension | BorderRadiuses): MenuAttribute; @@ -223,7 +238,8 @@ declare class MenuAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ menuItemDivider(options: DividerStyleOptions | undefined): MenuAttribute; @@ -235,7 +251,8 @@ declare class MenuAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ menuItemGroupDivider(options: DividerStyleOptions | undefined): MenuAttribute; @@ -247,7 +264,8 @@ declare class MenuAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ subMenuExpandingMode(mode: SubMenuExpandingMode): MenuAttribute; } diff --git a/api/@internal/component/ets/menu_item.d.ts b/api/@internal/component/ets/menu_item.d.ts index b95257ffab9157a0df25e245ee63df837a8f91ea..f83ad5a4e1fd239425f625879989484c34b2751f 100644 --- a/api/@internal/component/ets/menu_item.d.ts +++ b/api/@internal/component/ets/menu_item.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceStr, Font, ResourceColor } from './units'; +import { CommonMethod, Bindable } from './common'; +import { CustomBuilder } from './builder'; +import { SymbolGlyphModifier } from '../../arkui/SymbolGlyphModifier'; +/*** endif */ + /** * Defines the option of MenuItem. * @@ -40,7 +47,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MenuItemOptions { /** @@ -65,7 +73,8 @@ declare interface MenuItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startIcon?: ResourceStr; @@ -75,7 +84,8 @@ declare interface MenuItemOptions { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolStartIcon?: SymbolGlyphModifier; @@ -101,7 +111,8 @@ declare interface MenuItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ content?: ResourceStr; @@ -127,7 +138,8 @@ declare interface MenuItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endIcon?: ResourceStr; @@ -137,7 +149,8 @@ declare interface MenuItemOptions { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolEndIcon?: SymbolGlyphModifier; @@ -163,7 +176,8 @@ declare interface MenuItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ labelInfo?: ResourceStr; @@ -189,7 +203,8 @@ declare interface MenuItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ builder?: CustomBuilder; } @@ -216,7 +231,8 @@ declare interface MenuItemOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface MenuItemInterface { /** @@ -244,7 +260,8 @@ interface MenuItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: MenuItemOptions | CustomBuilder): MenuItemAttribute; } @@ -271,7 +288,8 @@ interface MenuItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class MenuItemAttribute extends CommonMethod { /** @@ -303,6 +321,20 @@ declare class MenuItemAttribute extends CommonMethod { */ selected(value: boolean): MenuItemAttribute; + /** + * Setting whether menuItem is selected. + * + * @param { boolean | undefined | Bindable } value + * @returns { MenuItemAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + selected(value: boolean | undefined | Bindable): MenuItemAttribute; + + /** * Whether the relevant check icon is displayed when a menu item is selected. * @@ -350,7 +382,8 @@ declare class MenuItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectIcon(value: boolean | ResourceStr | SymbolGlyphModifier): MenuItemAttribute; @@ -379,7 +412,8 @@ declare class MenuItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: (selected: boolean) => void): MenuItemAttribute; @@ -402,7 +436,8 @@ declare class MenuItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ contentFont(value: Font): MenuItemAttribute; @@ -423,7 +458,8 @@ declare class MenuItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ contentFontColor(value: ResourceColor): MenuItemAttribute; @@ -446,7 +482,8 @@ declare class MenuItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ labelFont(value: Font): MenuItemAttribute; @@ -467,7 +504,8 @@ declare class MenuItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ labelFontColor(value: ResourceColor): MenuItemAttribute; } diff --git a/api/@internal/component/ets/menu_item_group.d.ts b/api/@internal/component/ets/menu_item_group.d.ts index e7e7b8920457ef5ec570d05854e16b40d1a57a36..fa5e23ff42266d460da0a239e866870d6ff9cec1 100644 --- a/api/@internal/component/ets/menu_item_group.d.ts +++ b/api/@internal/component/ets/menu_item_group.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +import { CustomBuilder } from './builder'; +import { ResourceStr } from './units'; +/*** endif */ + /** * Defines the option of MenuItemGroup. * @@ -40,7 +46,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MenuItemGroupOptions { /** @@ -65,7 +72,8 @@ declare interface MenuItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ header?: ResourceStr | CustomBuilder; @@ -91,7 +99,8 @@ declare interface MenuItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ footer?: ResourceStr | CustomBuilder; } @@ -118,7 +127,8 @@ declare interface MenuItemGroupOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface MenuItemGroupInterface { /** @@ -146,7 +156,8 @@ interface MenuItemGroupInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: MenuItemGroupOptions): MenuItemGroupAttribute; } @@ -173,7 +184,8 @@ interface MenuItemGroupInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class MenuItemGroupAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/nav_destination.d.ts b/api/@internal/component/ets/nav_destination.d.ts index 251228b73861dcfdac986f69ad021a9860bbaf4b..a32de22d206b0c4eb5d4fbb9bc95dc97869a6022 100644 --- a/api/@internal/component/ets/nav_destination.d.ts +++ b/api/@internal/component/ets/nav_destination.d.ts @@ -18,6 +18,22 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource' +import { CommonMethod, Callback, LayoutSafeAreaType, LayoutSafeAreaEdge, Optional, PixelMap } from './common' +import { CustomBuilder } from './builder' +import { Length, ResourceStr } from './units' +import { TitleHeight, Curve } from './enums' +import { + NavPathInfo, NavPathStack, NavigationTitleOptions, NavigationMenuItem, NavigationToolbarOptions, + ToolbarItem, NavigationMenuOptions, NavigationOperation, SystemBarStyle +} from './navigation' +import { SymbolGlyphModifier } from '../../arkui/SymbolGlyphModifier' +import window from '../../@ohos.window' +import image from '../../@ohos.multimedia.image' +import { Scroller } from './scroll' +/*** endif */ + /** * Import the Orientation type from @ohos.window. * @@ -25,10 +41,22 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since 19 */ declare type Orientation = import('../api/@ohos.window').default.Orientation; +/** + * Import the Orientation type from @ohos.window. + * + * @typedef { import('../api/@ohos.window').default.Orientation } Orientation + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type Orientation = window.Orientation; + /** * Defines the navigation destination common title. * @@ -51,7 +79,8 @@ declare type Orientation = import('../api/@ohos.window').default.Orientation; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavDestinationCommonTitle { /** @@ -85,7 +114,8 @@ declare interface NavDestinationCommonTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ main: string | Resource; @@ -120,7 +150,8 @@ declare interface NavDestinationCommonTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ sub: string | Resource; } @@ -147,7 +178,8 @@ declare interface NavDestinationCommonTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavDestinationCustomTitle { /** @@ -172,7 +204,8 @@ declare interface NavDestinationCustomTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ builder: CustomBuilder; @@ -198,7 +231,8 @@ declare interface NavDestinationCustomTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height: TitleHeight | Length; } @@ -210,7 +244,8 @@ declare interface NavDestinationCustomTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavigationSystemTransitionType { /** @@ -219,7 +254,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, /** @@ -228,7 +264,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 1, /** @@ -237,7 +274,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ TITLE = 2, /** @@ -246,7 +284,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT = 3, /** @@ -255,7 +294,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ FADE = 4, /** @@ -264,7 +304,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ EXPLODE = 5, /** @@ -273,7 +314,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ SLIDE_RIGHT = 6, /** @@ -282,7 +324,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ SLIDE_BOTTOM = 7, } @@ -302,7 +345,8 @@ declare enum NavigationSystemTransitionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavDestinationMode { /** @@ -318,7 +362,8 @@ declare enum NavDestinationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STANDARD = 0, @@ -335,7 +380,8 @@ declare enum NavDestinationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DIALOG = 1, } @@ -347,7 +393,8 @@ declare enum NavDestinationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavDestinationActiveReason { /** @@ -356,7 +403,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TRANSITION = 0, @@ -366,7 +414,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_COVER = 1, @@ -376,7 +425,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SHEET = 2, @@ -386,7 +436,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ DIALOG = 3, @@ -396,7 +447,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ OVERLAY = 4, @@ -406,7 +458,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ APP_STATE = 5, } @@ -433,7 +486,8 @@ declare enum NavDestinationActiveReason { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavDestinationInterface { /** @@ -458,7 +512,8 @@ declare interface NavDestinationInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): NavDestinationAttribute; } @@ -470,7 +525,8 @@ declare interface NavDestinationInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RouteMapConfig { /** @@ -480,7 +536,8 @@ declare interface RouteMapConfig { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -491,7 +548,8 @@ declare interface RouteMapConfig { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pageSourceFile: string; @@ -502,7 +560,8 @@ declare interface RouteMapConfig { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ data: Object } @@ -514,7 +573,8 @@ declare interface RouteMapConfig { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavDestinationContext { /** @@ -524,7 +584,8 @@ declare interface NavDestinationContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pathInfo: NavPathInfo; @@ -535,7 +596,8 @@ declare interface NavDestinationContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pathStack: NavPathStack; @@ -546,7 +608,8 @@ declare interface NavDestinationContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ navDestinationId?: string; @@ -558,7 +621,8 @@ declare interface NavDestinationContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getConfigInRouteMap(): RouteMapConfig | undefined; } @@ -570,7 +634,8 @@ declare interface NavDestinationContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NestedScrollInfo { /** @@ -580,7 +645,8 @@ declare interface NestedScrollInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ parent: Scroller; @@ -591,7 +657,8 @@ declare interface NestedScrollInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ child: Scroller; } @@ -603,7 +670,8 @@ declare interface NestedScrollInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice -* @since 15 +* @since arkts {'1.1':'15','1.2':'20'} +* @arkts 1.1&1.2 */ declare interface NavDestinationTransition { /** @@ -613,7 +681,8 @@ declare interface NavDestinationTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onTransitionEnd?: Callback; @@ -624,7 +693,8 @@ declare interface NavDestinationTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; @@ -635,7 +705,8 @@ declare interface NavDestinationTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve; @@ -646,7 +717,8 @@ declare interface NavDestinationTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ delay?: number; @@ -657,7 +729,8 @@ declare interface NavDestinationTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ event: Callback; } @@ -684,7 +757,8 @@ declare interface NavDestinationTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class NavDestinationAttribute extends CommonMethod { /** @@ -734,10 +808,11 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -810,7 +888,8 @@ declare class NavDestinationAttribute extends CommonMethod void): NavDestinationAttribute; @@ -831,7 +910,8 @@ declare class NavDestinationAttribute extends CommonMethod void): NavDestinationAttribute; @@ -852,7 +932,8 @@ declare class NavDestinationAttribute extends CommonMethod boolean): NavDestinationAttribute; @@ -885,7 +966,8 @@ declare class NavDestinationAttribute extends CommonMethod | CustomBuilder): NavDestinationAttribute; @@ -944,7 +1030,8 @@ declare class NavDestinationAttribute extends CommonMethod | CustomBuilder, options?: NavigationMenuOptions): NavDestinationAttribute; @@ -957,7 +1044,8 @@ declare class NavDestinationAttribute extends CommonMethod | CustomBuilder, options?: NavigationToolbarOptions): NavDestinationAttribute; @@ -970,7 +1058,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; + /** + * Invoked before sub-components of NavDestination are created. + * + * @param { Callback } callback + * - Indicates callback that invoked before sub-components of NavDestination are created. + * @returns { NavDestinationAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onReady(callback: Callback): NavDestinationAttribute; + /** * Invoked before the navDestination is appeared. * @@ -995,7 +1098,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1007,7 +1111,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1019,7 +1124,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1031,7 +1137,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1044,7 +1151,8 @@ declare class NavDestinationAttribute extends CommonMethod, edges?: Array): NavDestinationAttribute; @@ -1055,7 +1163,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1066,7 +1175,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1078,7 +1188,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1102,7 +1214,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1114,7 +1227,8 @@ declare class NavDestinationAttribute extends CommonMethod>): NavDestinationAttribute; @@ -1126,7 +1240,8 @@ declare class NavDestinationAttribute extends CommonMethod>): NavDestinationAttribute; @@ -1138,7 +1253,8 @@ declare class NavDestinationAttribute extends CommonMethod>): NavDestinationAttribute; - + /** + * Invoked when destination be pushed with singleton mode. + * + * @param { Optional> } callback - Indicates callback when destination be pushed with singleton mode. + * @returns { NavDestinationAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onNewParam(callback: Optional>): NavDestinationAttribute; /** * Set NavDestination's preferred Orientation. * @@ -1162,7 +1289,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; @@ -1176,7 +1304,8 @@ declare class NavDestinationAttribute extends CommonMethod, animated?: boolean): NavDestinationAttribute; @@ -1188,7 +1317,8 @@ declare class NavDestinationAttribute extends CommonMethod): NavDestinationAttribute; } @@ -1249,7 +1379,8 @@ declare const NavDestinationInstance: NavDestinationAttribute; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type NavDestinationTransitionDelegate = (operation: NavigationOperation, isEnter: boolean) => Array | undefined; \ No newline at end of file diff --git a/api/@internal/component/ets/navigation.d.ts b/api/@internal/component/ets/navigation.d.ts index 8b63cf59734f4d177a2f69a1c3a187ec5be70960..ada4780ea71de103b2b2b625378d79b2aa172cfe 100644 --- a/api/@internal/component/ets/navigation.d.ts +++ b/api/@internal/component/ets/navigation.d.ts @@ -18,6 +18,19 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import window from '../../@ohos.window'; +import { Resource } from '../../global/resource'; +import { TextModifier } from '../../arkui/TextModifier'; +import { LengthMetrics } from '../../arkui/Graphics'; +import { Callback, BlurStyle, CommonMethod, Optional, LayoutSafeAreaType, LayoutSafeAreaEdge, BackgroundEffectOptions, BackgroundBlurStyleOptions, PixelMap, Bindable } from './common' +import { CustomBuilder, PageMapBuilder } from './builder' +import { Length, ResourceStr, ResourceColor, Dimension, VoidCallback } from './units' +import { TitleHeight } from './enums' +import { SymbolGlyphModifier } from '../../arkui/SymbolGlyphModifier' +import { NavDestinationContext, NavDestinationMode } from './navDestination' +/*** endif */ + /** * Import the SystemBarStyle type for Navigation. * @@ -28,6 +41,18 @@ */ declare type SystemBarStyle = import('../api/@ohos.window').default.SystemBarStyle; + +/** + * Import the SystemBarStyle type for Navigation. + * + * @typedef { window.SystemBarStyle } SystemBarStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type SystemBarStyle = window.SystemBarStyle; + /** * Defines the navigation common title. * @@ -50,7 +75,8 @@ declare type SystemBarStyle = import('../api/@ohos.window').default.SystemBarSty * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationCommonTitle { /** @@ -84,7 +110,8 @@ declare interface NavigationCommonTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ main: string | Resource; @@ -119,7 +146,8 @@ declare interface NavigationCommonTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ sub: string | Resource; } @@ -146,7 +174,8 @@ declare interface NavigationCommonTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationCustomTitle { /** @@ -171,7 +200,8 @@ declare interface NavigationCustomTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ builder: CustomBuilder; @@ -197,7 +227,8 @@ declare interface NavigationCustomTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height: TitleHeight | Length; } @@ -225,7 +256,8 @@ declare interface NavigationCustomTitle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavigationMode { /** @@ -247,7 +279,8 @@ declare enum NavigationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Stack, @@ -270,7 +303,8 @@ declare enum NavigationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Split, @@ -296,7 +330,8 @@ declare enum NavigationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, } @@ -323,7 +358,8 @@ declare enum NavigationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavBarPosition { /** @@ -345,7 +381,8 @@ declare enum NavBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -368,7 +405,8 @@ declare enum NavBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, } @@ -395,7 +433,8 @@ declare enum NavBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavigationTitleMode { /** @@ -417,7 +456,8 @@ declare enum NavigationTitleMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Free = 0, @@ -440,7 +480,8 @@ declare enum NavigationTitleMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Full, @@ -463,7 +504,8 @@ declare enum NavigationTitleMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Mini, } @@ -490,7 +532,8 @@ declare enum NavigationTitleMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationMenuItem { /** @@ -524,7 +567,8 @@ declare interface NavigationMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ value: string | Resource; @@ -559,7 +603,8 @@ declare interface NavigationMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: string | Resource; @@ -569,7 +614,8 @@ declare interface NavigationMenuItem { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolIcon?: SymbolGlyphModifier; @@ -580,7 +626,8 @@ declare interface NavigationMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isEnabled?: boolean; @@ -606,7 +653,8 @@ declare interface NavigationMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ action?: () => void; } @@ -626,7 +674,8 @@ declare interface NavigationMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PopInfo { /** @@ -644,7 +693,8 @@ declare interface PopInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ info: NavPathInfo; @@ -663,7 +713,8 @@ declare interface PopInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ result: Object; } @@ -681,7 +732,8 @@ declare interface PopInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class NavPathInfo { /** @@ -718,6 +770,21 @@ declare class NavPathInfo { */ constructor(name: string, param: unknown, onPop?: import('../api/@ohos.base').Callback, isEntry?: boolean); + /** + * Creates an instance of NavPathInfo. + * + * @param { string } name - The name of NavDestination. + * @param { Object | null | undefined } param - The detailed parameter of the NavDestination. + * @param { Callback } [onPop] - The callback when next page returns. + * @param { boolean } [isEntry] - Indicates whether it is an entry destination. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(name: string, param: Object | null | undefined, onPop?: Callback, isEntry?: boolean); + /** * The name of NavDestination. * @@ -733,7 +800,8 @@ declare class NavPathInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -756,6 +824,18 @@ declare class NavPathInfo { */ param?: unknown; + /** + * The detailed parameter of the NavDestination. + * + * @type { ?(Object | null | undefined) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + param?: Object | null | undefined; + /** * The callback when next page returns. * @@ -775,6 +855,18 @@ declare class NavPathInfo { */ onPop?: import('../api/@ohos.base').Callback; + /** + * The callback when next page returns. + * + * @type { ?Callback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onPop?: Callback; + /** * Indicates whether it is an entry destination. * @@ -782,7 +874,8 @@ declare class NavPathInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isEntry?: boolean; @@ -793,7 +886,8 @@ declare class NavPathInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ navDestinationId?: string; } @@ -805,7 +899,8 @@ declare class NavPathInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LaunchMode { /** @@ -814,7 +909,8 @@ declare enum LaunchMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STANDARD = 0, @@ -825,7 +921,8 @@ declare enum LaunchMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MOVE_TO_TOP_SINGLETON = 1, @@ -836,17 +933,19 @@ declare enum LaunchMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ POP_TO_SINGLETON = 2, - + /** * Forced to create a new NavDestination instance. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NEW_INSTANCE = 3, } @@ -858,7 +957,8 @@ declare enum LaunchMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationOptions { /** @@ -868,7 +968,8 @@ declare interface NavigationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ launchMode?: LaunchMode; @@ -879,7 +980,8 @@ declare interface NavigationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ animated?: boolean; } @@ -897,7 +999,8 @@ declare interface NavigationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class NavPathStack { /** @@ -913,7 +1016,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -933,7 +1037,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pushPath(info: NavPathInfo, animated?: boolean): void; @@ -945,7 +1050,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pushPath(info: NavPathInfo, options?: NavigationOptions): void; @@ -982,7 +1088,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pushDestination(info: NavPathInfo, animated?: boolean): Promise; @@ -1002,7 +1109,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pushDestination(info: NavPathInfo, options?: NavigationOptions): Promise; @@ -1028,6 +1136,20 @@ declare class NavPathStack { */ pushPathByName(name: string, param: unknown, animated?: boolean): void; + /** + * Pushes the specified NavDestination into the stack. + * + * @param { string } name - Indicates the name of the NavDestination to be pushed. + * @param { Object | null | undefined } param - Indicates the detailed parameter of the NavDestination to be pushed. + * @param { boolean } [animated] - Indicates whether the transition is animated. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pushPathByName(name: string, param: Object | null | undefined, animated?: boolean): void; + /** * Pushes the specified NavDestination into the stack. * @@ -1053,6 +1175,21 @@ declare class NavPathStack { */ pushPathByName(name: string, param: Object, onPop: import('../api/@ohos.base').Callback, animated?: boolean): void; + /** + * Pushes the specified NavDestination into the stack. + * + * @param { string } name - Indicates the name of the NavDestination to be pushed. + * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. + * @param { Callback } onPop - The callback when next page returns. + * @param { boolean } [animated] - Indicates whether the transition is animated. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pushPathByName(name: string, param: Object, onPop: Callback, animated?: boolean): void; + /** * Pushes the specified NavDestination into the stack. * @@ -1088,7 +1225,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pushDestinationByName(name: string, param: Object, animated?: boolean): Promise; @@ -1133,6 +1271,29 @@ declare class NavPathStack { */ pushDestinationByName(name: string, param: Object, onPop: import('../api/@ohos.base').Callback, animated?: boolean): Promise; + /** + * Pushes the specified NavDestination into the stack. + * + * @param { string } name - Indicates the name of the NavDestination to be pushed. + * @param { Object } param - Indicates the detailed parameter of the NavDestination to be pushed. + * @param { Callback } onPop - The callback when next page returns. + * @param { boolean } [animated] - Indicates whether the transition is animated. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified. + * 2. Incorrect parameters types. + * 3. Parameter verification failed. + * @throws { BusinessError } 100001 - Internal error. + * @throws { BusinessError } 100005 - Builder function not registered. + * @throws { BusinessError } 100006 - NavDestination not found. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pushDestinationByName(name: string, param: Object, onPop: Callback, animated?: boolean): Promise; + /** * Replace the current NavDestination with the specific one.The current NavDestination will be destroyed. * @@ -1150,7 +1311,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacePath(info: NavPathInfo, animated?: boolean): void; @@ -1162,7 +1324,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacePath(info: NavPathInfo, options?: NavigationOptions): void; @@ -1182,7 +1345,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ replaceDestination(info: NavPathInfo, options?: NavigationOptions): Promise; @@ -1205,7 +1369,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacePathByName(name: string, param: Object, animated?: boolean): void; @@ -1226,7 +1391,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeByIndexes(indexes: Array): number; @@ -1247,7 +1413,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeByName(name: string): number; @@ -1259,7 +1426,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeByNavDestinationId(navDestinationId: string): boolean; @@ -1279,7 +1447,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pop(animated?: boolean): NavPathInfo | undefined; @@ -1302,7 +1471,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pop(result: Object, animated?: boolean): NavPathInfo | undefined; @@ -1324,7 +1494,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ popToName(name: string, animated?: boolean): number; @@ -1349,7 +1520,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ popToName(name: string, result: Object, animated?: boolean): number; @@ -1369,7 +1541,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ popToIndex(index: number, animated?: boolean): void; @@ -1382,7 +1555,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ popToIndex(index: number, result: Object, animated?: boolean): void; @@ -1404,7 +1578,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ moveToTop(name: string, animated?: boolean): number; @@ -1424,7 +1599,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ moveIndexToTop(index: number, animated?: boolean): void; @@ -1442,7 +1618,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clear(animated?: boolean): void; @@ -1461,7 +1638,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getAllPathName(): Array; @@ -1478,13 +1656,14 @@ declare class NavPathStack { * Obtains the param of the specified NavDestination. * * @param { number } index - Indicates the index of the NavDestination. - * @returns { unknown | undefined } Returns the detailed parameter of the NavDestination if it exists in the stack, otherwise returns undefined; + * @returns { Object | null | undefined } Returns the detailed parameter of the NavDestination if it exists in the stack, otherwise returns undefined; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - getParamByIndex(index: number): unknown | undefined; + getParamByIndex(index: number): Object | null | undefined; /** * Obtains the param of the specified NavDestination. @@ -1499,13 +1678,14 @@ declare class NavPathStack { * Obtains the param of the specified NavDestination. * * @param { string } name - Indicates the name of the NavDestination. - * @returns { Array } Returns the detailed parameter of all the NavDestinations. + * @returns { Array } Returns the detailed parameter of all the NavDestinations. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - getParamByName(name: string): Array; + getParamByName(name: string): Array; /** * Obtains the index of the specified NavDestination. @@ -1524,7 +1704,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getIndexByName(name: string): Array; @@ -1535,7 +1716,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getParent(): NavPathStack | null; @@ -1554,7 +1736,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size(): number; @@ -1573,7 +1756,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ disableAnimation(value: boolean): void; @@ -1584,7 +1768,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setInterception(interception: NavigationInterception): void; @@ -1595,7 +1780,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getPathStack(): Array; @@ -1607,7 +1793,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ setPathStack(pathStack: Array, animated?: boolean): void; } @@ -1619,7 +1806,8 @@ declare class NavPathStack { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type NavBar = 'navBar' @@ -1634,9 +1822,10 @@ declare type NavBar = 'navBar' * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type InterceptionShowCallback = (from: NavDestinationContext|NavBar, to: NavDestinationContext|NavBar, operation: NavigationOperation, isAnimated: boolean) => void; +declare type InterceptionShowCallback = (from: NavDestinationContext | NavBar, to: NavDestinationContext | NavBar, operation: NavigationOperation, isAnimated: boolean) => void; /** * navigation interception callback using in navigation mode change @@ -1646,7 +1835,8 @@ declare type InterceptionShowCallback = (from: NavDestinationContext|NavBar, to: * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type InterceptionModeCallback = (mode: NavigationMode) => void; @@ -1657,7 +1847,8 @@ declare type InterceptionModeCallback = (mode: NavigationMode) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationInterception { /** @@ -1668,7 +1859,8 @@ declare interface NavigationInterception { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ willShow?: InterceptionShowCallback; @@ -1679,7 +1871,8 @@ declare interface NavigationInterception { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ didShow?: InterceptionShowCallback; @@ -1690,7 +1883,8 @@ declare interface NavigationInterception { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ modeChange?: InterceptionModeCallback; } @@ -1717,7 +1911,8 @@ declare interface NavigationInterception { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface NavigationInterface { /** @@ -1742,7 +1937,8 @@ interface NavigationInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): NavigationAttribute; @@ -1763,7 +1959,8 @@ interface NavigationInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (pathInfos: NavPathStack): NavigationAttribute; } @@ -1782,7 +1979,8 @@ interface NavigationInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ToolbarItemStatus { /** @@ -1797,7 +1995,8 @@ declare enum ToolbarItemStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, @@ -1813,7 +2012,8 @@ declare enum ToolbarItemStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DISABLED = 1, @@ -1829,7 +2029,8 @@ declare enum ToolbarItemStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ACTIVE = 2, } @@ -1849,7 +2050,8 @@ declare enum ToolbarItemStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NavigationOperation { /** @@ -1865,7 +2067,8 @@ declare enum NavigationOperation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PUSH = 1, @@ -1882,7 +2085,8 @@ declare enum NavigationOperation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ POP = 2, @@ -1899,7 +2103,8 @@ declare enum NavigationOperation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REPLACE = 3, } @@ -1917,7 +2122,8 @@ declare enum NavigationOperation { * @interface ToolbarItem * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ToolbarItem { /** @@ -1935,7 +2141,8 @@ declare interface ToolbarItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: ResourceStr; @@ -1954,7 +2161,8 @@ declare interface ToolbarItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: ResourceStr; @@ -1964,7 +2172,8 @@ declare interface ToolbarItem { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolIcon?: SymbolGlyphModifier; @@ -1983,7 +2192,8 @@ declare interface ToolbarItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ action?: () => void; @@ -2002,7 +2212,8 @@ declare interface ToolbarItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ status?: ToolbarItemStatus; @@ -2021,7 +2232,8 @@ declare interface ToolbarItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ activeIcon?: ResourceStr; @@ -2031,7 +2243,8 @@ declare interface ToolbarItem { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ activeSymbolIcon?: SymbolGlyphModifier; } @@ -2043,7 +2256,8 @@ declare interface ToolbarItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationTitleOptions { /** @@ -2053,7 +2267,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -2064,7 +2279,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -2075,7 +2291,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -2086,7 +2303,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -2098,7 +2316,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ barStyle?: BarStyle; @@ -2110,7 +2329,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ paddingStart?: LengthMetrics; @@ -2122,7 +2342,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ paddingEnd?: LengthMetrics; @@ -2133,7 +2354,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ mainTitleModifier?: TextModifier; @@ -2144,10 +2366,11 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ subTitleModifier?: TextModifier; - + /** * Defines whether to respond to the hover mode. * @@ -2156,7 +2379,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; } @@ -2168,7 +2392,8 @@ declare interface NavigationTitleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BarStyle { /** @@ -2177,7 +2402,8 @@ declare enum BarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STANDARD = 0, @@ -2187,7 +2413,8 @@ declare enum BarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STACK = 1, @@ -2197,7 +2424,8 @@ declare enum BarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ SAFE_AREA_PADDING = 2, } @@ -2209,7 +2437,8 @@ declare enum BarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationToolbarOptions { /** @@ -2219,7 +2448,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -2230,7 +2460,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -2241,7 +2472,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -2252,7 +2484,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -2263,7 +2496,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ moreButtonOptions?: MoreButtonOptions; @@ -2275,7 +2509,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ barStyle?: BarStyle; @@ -2287,7 +2522,8 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ hideItemValue?: boolean } @@ -2299,18 +2535,20 @@ declare interface NavigationToolbarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavigationMenuOptions { -/** - * More button options. - * - * @type { ?MoreButtonOptions } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ + /** + * More button options. + * + * @type { ?MoreButtonOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ moreButtonOptions?: MoreButtonOptions; } @@ -2321,7 +2559,8 @@ declare interface NavigationMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MoreButtonOptions { /** @@ -2331,10 +2570,11 @@ declare interface MoreButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; - + /** * Background blur style options. * @@ -2342,7 +2582,8 @@ declare interface MoreButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -2353,7 +2594,8 @@ declare interface MoreButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; } @@ -2380,7 +2622,8 @@ declare interface MoreButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class NavigationAttribute extends CommonMethod { /** @@ -2412,6 +2655,19 @@ declare class NavigationAttribute extends CommonMethod { */ navBarWidth(value: Length): NavigationAttribute; + /** + * Sets the width of navigation bar. + * + * @param { Length | Bindable } value + * @returns { NavigationAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + navBarWidth(value: Length | Bindable): NavigationAttribute; + /** * Sets the position of navigation bar. * @@ -2437,7 +2693,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ navBarPosition(value: NavBarPosition): NavigationAttribute; @@ -2458,7 +2715,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ navBarWidthRange(value: [Dimension, Dimension]): NavigationAttribute; @@ -2479,7 +2737,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ minContentWidth(value: Dimension): NavigationAttribute; @@ -2508,7 +2767,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mode(value: NavigationMode): NavigationAttribute; @@ -2547,7 +2807,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backButtonIcon(value: string | PixelMap | Resource | SymbolGlyphModifier): NavigationAttribute; @@ -2560,7 +2821,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ backButtonIcon(icon: string | PixelMap | Resource | SymbolGlyphModifier, accessibilityText?: ResourceStr): NavigationAttribute; @@ -2590,7 +2852,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hideNavBar(value: boolean): NavigationAttribute; @@ -2628,7 +2891,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title(value: ResourceStr | CustomBuilder | NavigationCommonTitle | NavigationCustomTitle, options?: NavigationTitleOptions): NavigationAttribute; @@ -2669,7 +2933,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hideTitleBar(value: boolean): NavigationAttribute; @@ -2682,7 +2947,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ hideTitleBar(hide: boolean, animated: boolean): NavigationAttribute; @@ -2711,7 +2977,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hideBackButton(value: boolean): NavigationAttribute; @@ -2740,7 +3007,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ titleMode(value: NavigationTitleMode): NavigationAttribute; @@ -2769,7 +3037,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ menus(value: Array | CustomBuilder): NavigationAttribute; @@ -2782,7 +3051,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ menus(items: Array | CustomBuilder, options?: NavigationMenuOptions): NavigationAttribute; @@ -2816,7 +3086,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + `* @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ toolbarConfiguration(value: Array | CustomBuilder, options?: NavigationToolbarOptions): NavigationAttribute; @@ -2845,7 +3116,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hideToolBar(value: boolean): NavigationAttribute; @@ -2858,7 +3130,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ hideToolBar(hide: boolean, animated: boolean): NavigationAttribute; @@ -2870,7 +3143,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableToolBarAdaptation(enable: Optional): NavigationAttribute; @@ -2899,7 +3173,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onTitleModeChange(callback: (titleMode: NavigationTitleMode) => void): NavigationAttribute; @@ -2928,7 +3203,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onNavBarStateChange(callback: (isVisible: boolean) => void): NavigationAttribute; @@ -2940,7 +3216,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onNavigationModeChange(callback: (mode: NavigationMode) => void): NavigationAttribute; @@ -2965,6 +3242,19 @@ declare class NavigationAttribute extends CommonMethod { */ navDestination(builder: (name: string, param: unknown) => void): NavigationAttribute; + /** + * Set builder for user-defined NavDestination component. + * + * @param { PageMapBuilder | undefined } builder - The builder function of NavDestination component. + * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + navDestination(builder: PageMapBuilder | undefined): NavigationAttribute; + /** * Set custom navigation content transition animation. * @@ -2982,7 +3272,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customNavContentTransition(delegate: (from: NavContentInfo, to: NavContentInfo, operation: NavigationOperation) => NavigationAnimatedTransition | undefined): NavigationAttribute; @@ -2995,7 +3286,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ignoreLayoutSafeArea(types?: Array, edges?: Array): NavigationAttribute; @@ -3006,10 +3298,11 @@ declare class NavigationAttribute extends CommonMethod { * @returns { NavigationAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ systemBarStyle(style: Optional): NavigationAttribute; - + /** * Set the Navigation can be restored after the application is terminated. * To enable this attribute, a navigation id must be set. @@ -3017,7 +3310,8 @@ declare class NavigationAttribute extends CommonMethod { * @param { boolean } recoverable - navigation can be recovered. * @returns { NavigationAttribute } Returns the instance of the NavigationAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ recoverable(recoverable: Optional): NavigationAttribute; @@ -3029,10 +3323,11 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableDragBar(isEnabled: Optional): NavigationAttribute; - + /** * whether to enable modeChangeAnimation * @@ -3041,7 +3336,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ enableModeChangeAnimation(isEnabled: Optional): NavigationAttribute; } @@ -3061,7 +3357,8 @@ declare class NavigationAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice -* @since 12 +* @since arkts {'1.1':'12','1.2':'20'} +* @arkts 1.1&1.2 */ declare interface NavigationAnimatedTransition { /** @@ -3079,7 +3376,8 @@ declare interface NavigationAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onTransitionEnd?: (success: boolean) => void @@ -3098,7 +3396,8 @@ declare interface NavigationAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ timeout?: number; @@ -3110,7 +3409,8 @@ declare interface NavigationAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isInteractive?: boolean; @@ -3129,7 +3429,8 @@ declare interface NavigationAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition: (transitionProxy: NavigationTransitionProxy) => void } @@ -3149,7 +3450,8 @@ declare interface NavigationAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 +* @since arkts {'1.1':'12','1.2':'20'} +* @arkts 1.1&1.2 */ declare interface NavigationTransitionProxy { /** @@ -3167,7 +3469,8 @@ declare interface NavigationTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ from: NavContentInfo; @@ -3186,7 +3489,8 @@ declare interface NavigationTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ to: NavContentInfo; @@ -3198,7 +3502,8 @@ declare interface NavigationTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isInteractive?: boolean; @@ -3215,7 +3520,8 @@ declare interface NavigationTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ finishTransition(): void; @@ -3229,6 +3535,18 @@ declare interface NavigationTransitionProxy { */ cancelTransition?(): void; + /** + * Notification system transition animation canceled. + * + * @type { ?VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + cancelTransition?: VoidCallback; + /** * Notification system transition animation update. * @@ -3239,8 +3557,33 @@ declare interface NavigationTransitionProxy { * @since 12 */ updateTransition?(progress: number): void; + + /** + * Notification system transition animation update. + * + * @type { ?UpdateTransitionCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + updateTransition?: UpdateTransitionCallback; } +/** + * navigation update transition callback. + * + * @typedef { function } UpdateTransitionCallback + * @param { number } progress - Indicates the process of transition + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type UpdateTransitionCallback = (progress: number) => void; + /** * Navigation content info. * @@ -3256,7 +3599,8 @@ declare interface NavigationTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NavContentInfo { /** @@ -3274,7 +3618,8 @@ declare interface NavContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name?: string; @@ -3293,7 +3638,8 @@ declare interface NavContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -3312,7 +3658,8 @@ declare interface NavContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ mode?: NavDestinationMode; @@ -3323,7 +3670,8 @@ declare interface NavContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ param?: Object; @@ -3334,7 +3682,8 @@ declare interface NavContentInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ navDestinationId?: string; } diff --git a/api/@internal/component/ets/node_container.d.ts b/api/@internal/component/ets/node_container.d.ts index 074ad34b57e164e1dc2971b4b2283886be3a61d0..85dde515625b7cba65a8ee30830df501c9d15737 100644 --- a/api/@internal/component/ets/node_container.d.ts +++ b/api/@internal/component/ets/node_container.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { NodeController } from '../../@ohos.arkui.node'; +import { CommonMethod } from './common'; +/*** endif */ + /** * Defines the Interface of NodeContainer. To display the node build by an associated NodeController. * @@ -33,7 +38,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface NodeContainerInterface { /** @@ -56,6 +62,18 @@ interface NodeContainerInterface { * @since 12 */ (controller: import('../api/@ohos.arkui.node').NodeController): NodeContainerAttribute; + /** + * Constructor parameters + * + * @param { NodeController } controller - Indicates the controller of the NodeContainer. + * @returns { NodeContainerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (controller: NodeController): NodeContainerAttribute; } /** @@ -71,7 +89,8 @@ interface NodeContainerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class NodeContainerAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/page_transition.d.ts b/api/@internal/component/ets/page_transition.d.ts index eeb29f55a0b52032f6e8147f88475269d1dea969..5c7380cc7bc4d7adbfdf6feb8a53cd07348e6c7f 100644 --- a/api/@internal/component/ets/page_transition.d.ts +++ b/api/@internal/component/ets/page_transition.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ICurve, TranslateOptions, ScaleOptions } from './common' +import { Curve } from './enums' +/*** endif */ + /** * Declare the jump method. * @@ -40,7 +45,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RouteType { /** @@ -62,7 +68,8 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, @@ -85,7 +92,8 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Push, @@ -108,7 +116,8 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Pop, } @@ -135,7 +144,8 @@ declare enum RouteType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SlideEffect { /** @@ -157,7 +167,8 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Left, @@ -180,7 +191,8 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Right, @@ -203,7 +215,8 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Top, @@ -226,7 +239,8 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Bottom, @@ -236,7 +250,8 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START = 5, @@ -246,7 +261,8 @@ declare enum SlideEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END = 6, } @@ -433,6 +449,69 @@ declare class CommonTransition { opacity(value: number): T; } +/** + * Provides interfaces for common transitions. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare class CommonTransition { + /** + * Called when the slide in effect of the transition is set. + * + * @param { SlideEffect } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + slide(value: SlideEffect): this; + + /** + * Called when the translation effect of page transition is set. + * + * @param { TranslateOptions } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + translate(value: TranslateOptions): this; + + /** + * Called when setting the zoom effect of page transition. + * + * @param { ScaleOptions } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scale(value: ScaleOptions): this; + + /** + * Called when the transparency value of the starting point of entry or the ending point of exit is set. + * + * @param { number } value + * @returns { this } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + opacity(value: number): this; +} + /** * Defines pageTransition constructor parameters. * @@ -455,7 +534,8 @@ declare class CommonTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PageTransitionOptions { /** @@ -477,7 +557,8 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type?: RouteType; /** @@ -499,7 +580,8 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; /** @@ -524,7 +606,8 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | string | ICurve; /** @@ -549,7 +632,8 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ delay?: number; } @@ -563,7 +647,8 @@ declare interface PageTransitionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type PageTransitionCallback = (type: RouteType, progress: number) => void; @@ -667,6 +752,48 @@ interface PageTransitionEnterInterface extends CommonTransition = [T1, T2]; @@ -36,7 +44,8 @@ declare type ParticleTuple = [T1, T2]; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface VelocityOptions { /** @@ -54,6 +63,17 @@ declare interface VelocityOptions { * @atomicservice * @since 11 */ + /** + * Particle speed. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ speed: ParticleTuple; /** @@ -71,6 +91,17 @@ declare interface VelocityOptions { * @atomicservice * @since 11 */ + /** + * Angle of particle's direction. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts{ '1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ angle: ParticleTuple; } @@ -81,7 +112,7 @@ declare interface VelocityOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ declare interface AccelerationOptions< ACC_SPEED_UPDATER extends ParticleUpdater, @@ -102,6 +133,16 @@ declare interface AccelerationOptions< * @atomicservice * @since 11 */ + /** + * Speed property options. + * + * Anonymous Object Rectification. + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ speed?: ParticlePropertyOptions; /** @@ -119,9 +160,55 @@ declare interface AccelerationOptions< * @atomicservice * @since 11 */ + /** + * Angle property options. + * + * Anonymous Object Rectification. + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ angle?: ParticlePropertyOptions; } +/** + * Defines acceleration options. + * + * @interface AccelerationOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface AccelerationOptions { + /** + * Speed property options. + * + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + speed?: ParticlePropertyOptions; + + /** + * Angle property options. + * + * @type { ?ParticlePropertyOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + angle?: ParticlePropertyOptions; +} + /** * Defines the ParticleOptions Interface. * @interface ParticleOptions @@ -239,12 +326,14 @@ interface ParticleOptions< */ /** * Particle velocity. + * + * Anonymous Object Rectification. * @type { ?VelocityOptions } * @default {speed:[0,0];angle:[0,0]} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ velocity?: VelocityOptions; @@ -267,12 +356,14 @@ interface ParticleOptions< */ /** * Particle acceleration. + * + * Anonymous Object Rectification. * @type { ?AccelerationOptions } * @default {speed:{range:[0,0]};angle:{range:[0,0]}} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ acceleration?: AccelerationOptions; @@ -296,6 +387,102 @@ interface ParticleOptions< spin?: ParticlePropertyOptions; } +/** + * Defines the ParticleOptions Interface. + * @interface ParticleOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface ParticleOptions { + /** + * Particle emitter. + * @type { EmitterOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + emitter: EmitterOptions; + + /** + * Particle color. + * @type { ?ParticleColorPropertyOptions } + * @default {range:['#FFFFFF','#FFFFFF']} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color?: ParticleColorPropertyOptions; + + /** + * Particle opacity. + * @type { ?ParticlePropertyOptions } + * @default {range:[1.0,1.0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + opacity?: ParticlePropertyOptions; + + /** + * Particle scale. + * @type { ?ParticlePropertyOptions } + * @default {range:[1.0,1.0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scale?: ParticlePropertyOptions; + + /** + * Particle velocity. + * + * @type { ?VelocityOptions } + * @default {speed:[0,0];angle:[0,0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + velocity?: VelocityOptions; + + /** + * Particle acceleration. + * + * @type { ?AccelerationOptions } + * @default {speed:{range:[0,0]};angle:{range:[0,0]}} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + acceleration?: AccelerationOptions; + + /** + * Particle spin. + * @type { ?ParticlePropertyOptions } + * @default {range:[0,0]} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + spin?: ParticlePropertyOptions; +} + /** * Defines the parameters for a point-like particle. * @interface PointParticleParameters @@ -309,7 +496,8 @@ interface ParticleOptions< * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PointParticleParameters { /** @@ -325,7 +513,8 @@ interface PointParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radius: VP; } @@ -343,7 +532,8 @@ interface PointParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImageParticleParameters { /** @@ -359,7 +549,8 @@ interface ImageParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ src: ResourceStr; @@ -380,11 +571,14 @@ interface ImageParticleParameters { */ /** * Particle image size. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ size: ParticleTuple; @@ -403,7 +597,8 @@ interface ImageParticleParameters { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit?: ImageFit; } @@ -459,6 +654,17 @@ interface ParticleConfigs { [ParticleType.IMAGE]: ImageParticleParameters; } +/** + * Defines the particle configs. + * @typedef {PointParticleParameters | ImageParticleParameters} ParticleConfigs + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type ParticleConfigs = PointParticleParameters | ImageParticleParameters; + /** * Defines the emitter property. * @@ -466,7 +672,8 @@ interface ParticleConfigs { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface EmitterProperty { @@ -477,7 +684,8 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -488,7 +696,8 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ emitRate?: number; @@ -499,7 +708,8 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position?: PositionT; @@ -510,9 +720,22 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size?: SizeT; + + /** + * the description of the annulus region. This parameter is valid only for emitter whose shape is annulus. + * + * @type { ?ParticleAnnulusRegion } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + annulusRegion?: ParticleAnnulusRegion; } /** @@ -522,7 +745,7 @@ interface EmitterProperty { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface EmitterParticleOptions { /** @@ -540,6 +763,16 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle type. + * + * Anonymous Object Rectification. + * @type { PARTICLE } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ type: PARTICLE; /** * Particle config. @@ -556,6 +789,16 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle config. + * + * Anonymous Object Rectification. + * @type { ParticleConfigs[PARTICLE] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ config: ParticleConfigs[PARTICLE]; /** @@ -573,6 +816,16 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle count. + * + * Anonymous Object Rectification. + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ count: number; /** @@ -592,6 +845,17 @@ interface EmitterParticleOptions { * @atomicservice * @since 11 */ + /** + * Particle lifetime. + * + * Anonymous Object Rectification. + * @type { ?number } + * @default 1000 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ lifetime?: number; /** @@ -604,6 +868,93 @@ interface EmitterParticleOptions { * @atomicservice * @since 12 */ + /** + * Particle lifetimeRange,value range [0, ∞). + * when lifetimeRange>lifetime,minimum lifetime is 0. + * + * Anonymous Object Rectification. + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ + lifetimeRange?: number; +} + +/** + * Defines parameters of particles used by emitters. + * + * @interface EmitterParticleOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface EmitterParticleOptions { + /** + * Particle type. + * + * @type { ParticleType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type: ParticleType; + + /** + * Particle config. + * + * @type { ParticleConfigs } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + config: ParticleConfigs; + + /** + * Particle count. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + count: number; + + /** + * Particle lifetime. + * + * @type { ?number } + * @default 1000 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + lifetime?: number; + + /** + * Particle lifetimeRange,value range [0, ∞). + * when lifetimeRange>lifetime,minimum lifetime is 0. + * + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ lifetimeRange?: number; } @@ -640,11 +991,13 @@ interface EmitterOptions { */ /** * Set particle config. + * + * Anonymous Object Rectification. * @type { EmitterParticleOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ particle: EmitterParticleOptions; @@ -711,12 +1064,14 @@ interface EmitterOptions { * Position of emitter. * The first element means X-axis location. * The second element means the Y-axis location. + * + * Anonymous Object Rectification. * @type { ?ParticleTuple } * @default [0,0] * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ position?: ParticleTuple; @@ -745,14 +1100,118 @@ interface EmitterOptions { * Size of emitter. * The first element means emitter width. * The second element means emitter height. + * + * Anonymous Object Rectification. + * @type { ?ParticleTuple } + * @default ['100%','100%'] + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ + size?: ParticleTuple; + + /** + * the description of the annulus region. This parameter is valid only for emitter whose shape is annulus. + * + * @type { ?ParticleAnnulusRegion } + * @default {innerRadius:LengthMetrics.vp(0),outerRadius:LengthMetrics.vp(0)} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + annulusRegion?: ParticleAnnulusRegion; +} + +/** + * Defines the emitter Options. + * @interface EmitterOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface EmitterOptions { + /** + * Set particle config. + * + * @type { EmitterParticleOptions } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + particle: EmitterParticleOptions; + + /** + * Emitting rate, that is, the number of particles produced per second. + * @type { ?number } + * @default 5 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + emitRate?: number; + + /** + * Shape of emitter. + * @type { ?ParticleEmitterShape } + * @default ParticleEmitterShape.RECTANGLE + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + shape?: ParticleEmitterShape; + + /** + * Position of emitter. + * The first element means X-axis location. + * The second element means the Y-axis location. + * + * @type { ?ParticleTuple } + * @default [0,0] + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + position?: ParticleTuple; + + /** + * Size of emitter. + * The first element means emitter width. + * The second element means emitter height. + * * @type { ?ParticleTuple } * @default ['100%','100%'] * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 20 + * @arkts 1.2 */ size?: ParticleTuple; + + /** + * the description of the annulus region. This parameter is valid only for emitter whose shape is annulus. + * + * @type { ?ParticleAnnulusRegion } + * @default {innerRadius:LengthMetrics.vp(0),outerRadius:LengthMetrics.vp(0)} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + annulusRegion?: ParticleAnnulusRegion; } /** @@ -807,11 +1266,13 @@ interface ParticlePropertyUpdaterConfigs { */ /** * Random effect of particle updater. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ [ParticleUpdater.RANDOM]: ParticleTuple; @@ -833,6 +1294,17 @@ interface ParticlePropertyUpdaterConfigs { [ParticleUpdater.CURVE]: Array>; } +/** + * Defines the particle property updater configs. + * @typedef { undefined | ParticleTuple | Array> } ParticlePropertyUpdaterConfigs + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type ParticlePropertyUpdaterConfigs = undefined | ParticleTuple | Array>; + /** * Defines the particle updater options. * @@ -840,7 +1312,7 @@ interface ParticlePropertyUpdaterConfigs { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface ParticleUpdaterOptions { /** @@ -858,6 +1330,16 @@ interface ParticleUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Particle updater type. + * + * Anonymous Object Rectification. + * @type { UPDATER } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ type: UPDATER; /** @@ -875,9 +1357,55 @@ interface ParticleUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Particle updater configuration. + * + * Anonymous Object Rectification. + * @type { ParticlePropertyUpdaterConfigs[UPDATER] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ config: ParticlePropertyUpdaterConfigs[UPDATER]; } +/** + * Defines the particle updater options. + * + * @typedef ParticleUpdaterOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface ParticleUpdaterOptions { + /** + * Particle updater type. + * + * @type { ParticleUpdater } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type: ParticleUpdater; + + /** + * Particle updater configuration. + * + * @type { ParticlePropertyUpdaterConfigs } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + config: ParticlePropertyUpdaterConfigs; +} + /** * Defines the particle color options. * @@ -885,7 +1413,8 @@ interface ParticleUpdaterOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface ParticleColorOptions { /** @@ -903,6 +1432,17 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Red component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts{ '1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ r: ParticleTuple; /** @@ -920,6 +1460,17 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Green component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts{ '1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ g: ParticleTuple; /** @@ -937,6 +1488,17 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Blue component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ b: ParticleTuple; /** @@ -954,6 +1516,17 @@ interface ParticleColorOptions { * @atomicservice * @since 11 */ + /** + * Opacity component of particle color. + * + * Anonymous Object Rectification. + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ a: ParticleTuple; } @@ -964,7 +1537,7 @@ interface ParticleColorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface ParticleColorUpdaterOptions { /** @@ -982,6 +1555,16 @@ interface ParticleColorUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Color updater. + * + * Anonymous Object Rectification. + * @type { UPDATER } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ type: UPDATER; /** @@ -999,9 +1582,55 @@ interface ParticleColorUpdaterOptions { * @atomicservice * @since 11 */ + /** + * Color updater configuration. + * + * Anonymous Object Rectification. + * @type { ParticleColorPropertyUpdaterConfigs[UPDATER] } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ config: ParticleColorPropertyUpdaterConfigs[UPDATER]; } +/** + * Defines the particle color updater options. + * + * @interface ParticleColorUpdaterOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface ParticleColorUpdaterOptions { + /** + * Color updater. + * + * @type { ParticleUpdater } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type: ParticleUpdater; + + /** + * Color updater configuration. + * + * @type { ParticleColorPropertyUpdaterConfigs } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + config: ParticleColorPropertyUpdaterConfigs; +} + /** * Defines the particle property Options. * @interface ParticlePropertyOptions @@ -1035,11 +1664,13 @@ interface ParticlePropertyOptions { */ /** * Initial range, within which the initial value are randomly generated. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ range: ParticleTuple; @@ -1062,16 +1693,54 @@ interface ParticlePropertyOptions { */ /** * Particle property updater. + * + * Anonymous Object Rectification. * @type { ?ParticleUpdaterOptions } * @default {type:UPDATER.NONE;config:ParticlePropertyUpdaterConfigs[UPDATER.NONE]} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ updater?: ParticleUpdaterOptions; } +/** + * Defines the particle property Options. + * @interface ParticlePropertyOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface ParticlePropertyOptions { + /** + * Initial range, within which the initial value are randomly generated. + * + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + range: ParticleTuple; + + /** + * Particle property updater. + * + * @type { ?ParticleUpdaterOptions } + * @default {type:UPDATER.NONE;config:undefined} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + updater?: ParticleUpdaterOptions; +} + /** * Defines the particle color property updater configs. * @interface ParticleColorPropertyUpdaterConfigs @@ -1124,11 +1793,13 @@ interface ParticleColorPropertyUpdaterConfigs { */ /** * Random effect of particle color property updater. + * + * Anonymous Object Rectification. * @type { ParticleColorOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ [ParticleUpdater.RANDOM]: ParticleColorOptions; @@ -1152,6 +1823,17 @@ interface ParticleColorPropertyUpdaterConfigs { [ParticleUpdater.CURVE]: Array>; } +/** + * Defines the particle color property updater configs. + * @typedef {undefined | ParticleColorOptions | Array>} ParticleColorPropertyUpdaterConfigs + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type ParticleColorPropertyUpdaterConfigs = undefined | ParticleColorOptions | Array>; + /** * Defines the particle color property updater configs which can support generics. * @interface ParticleColorPropertyOptions @@ -1185,11 +1867,13 @@ interface ParticleColorPropertyOptions { */ /** * Initial color range, within which the initial color is randomly generated. + * + * Anonymous Object Rectification. * @type { ParticleTuple } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ range: ParticleTuple; @@ -1223,16 +1907,66 @@ interface ParticleColorPropertyOptions { */ /** * Particle color property updater. + * + * Anonymous Object Rectification. * @type { ?ParticleColorUpdaterOptions } * @default {type:UPDATER.NONE;config:ParticleColorPropertyUpdaterConfigs[UPDATER.NONE]} * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ updater?: ParticleColorUpdaterOptions; } +/** + * Defines the particle color property updater. + * @interface ParticleColorPropertyOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface ParticleColorPropertyOptions { + /** + * Initial color range, within which the initial color is randomly generated. + * + * @type { ParticleTuple } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + range: ParticleTuple; + + /** + * Distribution type of particle color. + * @type { ?DistributionType } + * @default DistributionType.UNIFORM + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + distributionType?: DistributionType; + + /** + * Particle color property updater. + * + * @type { ?ParticleColorUpdaterOptions } + * @default {type:UPDATER.NONE;config:undefined} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + updater?: ParticleColorUpdaterOptions; +} + /** * Defines the particle property lifecycle. * @interface ParticlePropertyAnimation @@ -1246,7 +1980,8 @@ interface ParticleColorPropertyOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ParticlePropertyAnimation { /** @@ -1262,7 +1997,8 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ from: T; @@ -1279,7 +2015,8 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ to: T; @@ -1296,7 +2033,8 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startMillis: number; @@ -1313,7 +2051,8 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endMillis: number; @@ -1332,7 +2071,8 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | ICurve; } @@ -1344,7 +2084,7 @@ interface ParticlePropertyAnimation { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ interface Particles< PARTICLE extends ParticleType, @@ -1370,6 +2110,16 @@ interface Particles< * @atomicservice * @since 11 */ + /** + * Array of particles. + * + * Anonymous Object Rectification. + * @type { Array> } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ particles: Array< ParticleOptions< PARTICLE, @@ -1383,6 +2133,30 @@ interface Particles< >; } +/** + * Defines the Particles interface. + * + * @interface Particles + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface Particles { + /** + * Array of particles. + * + * @type { Array } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + particles: Array; +} + /** * Defines the particle Interface. * @interface ParticleInterface @@ -1420,13 +2194,15 @@ interface ParticleInterface { */ /** * create a particle array. + * + * Anonymous Object Rectification. * @param { Particles } particles - Array of particles. * @returns { ParticleAttribute } Returns the particle attribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since 18 */ < PARTICLE extends ParticleType, @@ -1447,6 +2223,23 @@ interface ParticleInterface { >): ParticleAttribute; } +/** + * Defines Particle Component. + * + * @param { Particles } particles - Particle infomation. + * @returns { ParticleAttribute } Returns the particle attribute. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +@memo +@ComponentBuilder +export declare function Particle( + particles: Particles +): ParticleAttribute + /** * Enumerates the particle types. * @enum { string } @@ -1460,7 +2253,8 @@ interface ParticleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ParticleType { /** @@ -1474,7 +2268,8 @@ declare enum ParticleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ POINT = 'point', @@ -1489,7 +2284,8 @@ declare enum ParticleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 'image', } @@ -1507,7 +2303,8 @@ declare enum ParticleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ParticleEmitterShape { /** @@ -1521,7 +2318,8 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RECTANGLE = 'rectangle', @@ -1536,7 +2334,8 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CIRCLE = 'circle', @@ -1551,9 +2350,20 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ELLIPSE = 'ellipse', + + /** + * Annulus. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + ANNULUS = 'annulus', } /** @@ -1563,7 +2373,8 @@ declare enum ParticleEmitterShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DistributionType { /** @@ -1572,7 +2383,8 @@ declare enum DistributionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UNIFORM = 0, @@ -1582,7 +2394,8 @@ declare enum DistributionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GAUSSIAN = 1, } @@ -1600,7 +2413,8 @@ declare enum DistributionType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ParticleUpdater { /** @@ -1614,7 +2428,8 @@ declare enum ParticleUpdater { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 'none', @@ -1629,7 +2444,8 @@ declare enum ParticleUpdater { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RANDOM = 'random', @@ -1644,7 +2460,8 @@ declare enum ParticleUpdater { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CURVE = 'curve', } @@ -1684,7 +2501,8 @@ declare type PositionT = import('../api/arkui/Graphics').PositionT; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ParticleAttribute extends CommonMethod { /** @@ -1695,7 +2513,8 @@ declare class ParticleAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ disturbanceFields(fields: Array): ParticleAttribute; @@ -1707,9 +2526,10 @@ declare class ParticleAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - emitter(value : Array) : ParticleAttribute; + emitter(value: Array): ParticleAttribute; } /** @@ -1733,7 +2553,8 @@ declare const Particle: ParticleInterface; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DisturbanceFieldOptions { @@ -1747,7 +2568,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strength?: number; @@ -1759,7 +2581,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shape?: DisturbanceFieldShape; @@ -1771,7 +2594,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size?: SizeT; @@ -1783,7 +2607,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position?: PositionT; @@ -1799,7 +2624,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ feather?: number; @@ -1811,7 +2637,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ noiseScale?: number; @@ -1823,7 +2650,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ noiseFrequency?: number; @@ -1835,7 +2663,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ noiseAmplitude?: number; } @@ -1847,7 +2676,8 @@ declare interface DisturbanceFieldOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DisturbanceFieldShape { @@ -1857,19 +2687,21 @@ declare enum DisturbanceFieldShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - RECT, + RECT = 0, - /** + /** * Shape circle. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - CIRCLE, + CIRCLE = 1, /** * Shape eclipse. @@ -1877,8 +2709,80 @@ declare enum DisturbanceFieldShape { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - ELLIPSE + ELLIPSE = 2 + +} -} \ No newline at end of file +/** + * Defines particle annuslus region params. + * + * @interface ParticleAnnulusRegion + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +declare interface ParticleAnnulusRegion { + /** + * The coordinates of the center of the annulus + * + * @type { ?PositionT } + * @default {x:LengthMetrics.percent(0.5),y:LengthMetrics.percent(0.5)} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + center?: PositionT, + /** + * The outer radius of the annulus + * + * @type { LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + outerRadius: LengthMetrics, + /** + * The inner radius of the annulus + * + * @type { LengthMetrics } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + innerRadius: LengthMetrics, + /** + * The start angle of the annulus, in degree + * + * @type { ?number } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + startAngle?: number, + /** + * The end angle of the annulus, in degree + * + * @type { ?number } + * @default 360 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + endAngle?: number, +} diff --git a/api/@internal/component/ets/paste_button.d.ts b/api/@internal/component/ets/paste_button.d.ts index e50c0fdb650d2ab8075e17871ad62fac4f84cb57..3eba6bab905fb71b471a5bcf8729eabb339cfb36 100644 --- a/api/@internal/component/ets/paste_button.d.ts +++ b/api/@internal/component/ets/paste_button.d.ts @@ -18,20 +18,28 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ButtonType } from './button'; +import { ClickEvent } from './common'; +import { SecurityComponentMethod } from './securityComponent'; +import { BusinessError } from '../../@ohos.base' +/*** endif */ + /** * Enumerates the icon styles. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ /** * Enumerates the icon styles. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PasteIconStyle { /** @@ -45,7 +53,8 @@ declare enum PasteIconStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LINES = 0 } @@ -53,17 +62,18 @@ declare enum PasteIconStyle { /** * Enumerates the text that can be displayed on the paste button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ /** * Enumerates the text that can be displayed on the paste button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PasteDescription { /** @@ -77,7 +87,8 @@ declare enum PasteDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PASTE = 0 } @@ -95,7 +106,8 @@ declare enum PasteDescription { * @interface PasteButtonOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PasteButtonOptions { /** @@ -111,7 +123,8 @@ declare interface PasteButtonOptions { * @type { ?PasteIconStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ icon?: PasteIconStyle; @@ -128,7 +141,8 @@ declare interface PasteButtonOptions { * @type { ?PasteDescription } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ text?: PasteDescription; @@ -145,7 +159,8 @@ declare interface PasteButtonOptions { * @type { ?ButtonType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ buttonType?: ButtonType; } @@ -153,17 +168,18 @@ declare interface PasteButtonOptions { /** * Enumerates the click event results of the paste button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ /** * Enumerates the click event results of the paste button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PasteButtonOnClickResult { /** @@ -177,7 +193,8 @@ declare enum PasteButtonOnClickResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SUCCESS = 0, @@ -192,7 +209,8 @@ declare enum PasteButtonOnClickResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ TEMPORARY_AUTHORIZATION_FAILED = 1 } @@ -210,7 +228,8 @@ declare enum PasteButtonOnClickResult { * @interface PasteButtonInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PasteButtonInterface { /** @@ -226,7 +245,8 @@ interface PasteButtonInterface { * @returns { PasteButtonAttribute } Returns the attribute of the paste button. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ (): PasteButtonAttribute; @@ -247,11 +267,14 @@ interface PasteButtonInterface { * @returns { PasteButtonAttribute } Returns the attribute of the paste button. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ (options: PasteButtonOptions): PasteButtonAttribute; } + + /** * Callback function when the paste button is clicked. * @@ -261,7 +284,8 @@ interface PasteButtonInterface { * @param { BusinessError } [error] - The error code and message of click event. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ type PasteButtonCallback = (event: ClickEvent, result: PasteButtonOnClickResult, error?: BusinessError) => void; @@ -278,7 +302,8 @@ type PasteButtonCallback = (event: ClickEvent, result: PasteButtonOnClickResult, * @extends SecurityComponentMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class PasteButtonAttribute extends SecurityComponentMethod { /** @@ -305,7 +330,8 @@ declare class PasteButtonAttribute extends SecurityComponentMethod { /** @@ -335,7 +344,8 @@ declare class PathAttribute extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ commands(value: string): PathAttribute; } @@ -403,3 +413,30 @@ declare const Path: PathInterface; * @since 11 */ declare const PathInstance: PathAttribute; + +/** + * Provides the path drawing interface. + * + * @interface PathInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface PathInterface { + /** + * Called when drawing path. + * + * @param { PathOptions } [options] - path options + * @returns { PathAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options?: PathOptions): PathAttribute; +} \ No newline at end of file diff --git a/api/@internal/component/ets/pattern_lock.d.ts b/api/@internal/component/ets/pattern_lock.d.ts index 2678e8fc41147c6f5aa58e5785eb2cea9719b145..688f4687b6706768d41ded084ffa6e9c96e20f8e 100644 --- a/api/@internal/component/ets/pattern_lock.d.ts +++ b/api/@internal/component/ets/pattern_lock.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor, Length } from './units' +import { LengthMetrics } from '../Graphics' +import { CommonMethod, Callback, Optional } from './common' +/*** endif */ + /** * The challenge result based on input pattern for control pattern lock component. * @enum { number } @@ -31,7 +37,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PatternLockChallengeResult { /** @@ -45,7 +52,8 @@ declare enum PatternLockChallengeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CORRECT = 1, /** @@ -59,7 +67,8 @@ declare enum PatternLockChallengeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WRONG = 2 } @@ -71,7 +80,8 @@ declare enum PatternLockChallengeResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CircleStyleOptions { /** @@ -81,7 +91,8 @@ declare interface CircleStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -92,7 +103,8 @@ declare interface CircleStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: LengthMetrics; @@ -103,7 +115,8 @@ declare interface CircleStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableWaveEffect?: boolean; @@ -114,9 +127,10 @@ declare interface CircleStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - enableForeground?: boolean; + enableForeground?: boolean; } /** @@ -138,7 +152,8 @@ declare interface CircleStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class PatternLockController { /** @@ -160,7 +175,8 @@ declare class PatternLockController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -186,6 +202,16 @@ declare class PatternLockController { * @since 12 */ reset(); + /** + * Reset pattern lock. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + reset(): void; /** * Set challenge result. @@ -200,7 +226,8 @@ declare class PatternLockController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setChallengeResult(result: PatternLockChallengeResult): void; } @@ -227,7 +254,8 @@ declare class PatternLockController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PatternLockInterface { /** @@ -255,7 +283,8 @@ interface PatternLockInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (controller?: PatternLockController): PatternLockAttribute; } @@ -282,7 +311,8 @@ interface PatternLockInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class PatternLockAttribute extends CommonMethod { /** @@ -310,7 +340,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sideLength(value: Length): PatternLockAttribute; @@ -339,7 +370,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ circleRadius(value: Length): PatternLockAttribute; @@ -368,7 +400,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor(value: ResourceColor): PatternLockAttribute; @@ -397,7 +430,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ regularColor(value: ResourceColor): PatternLockAttribute; @@ -426,7 +460,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(value: ResourceColor): PatternLockAttribute; @@ -455,7 +490,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ activeColor(value: ResourceColor): PatternLockAttribute; @@ -484,7 +520,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pathColor(value: ResourceColor): PatternLockAttribute; @@ -513,7 +550,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pathStrokeWidth(value: number | string): PatternLockAttribute; @@ -542,7 +580,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onPatternComplete(callback: (input: Array) => void): PatternLockAttribute; @@ -571,7 +610,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ autoReset(value: boolean): PatternLockAttribute; @@ -593,7 +633,19 @@ declare class PatternLockAttribute extends CommonMethod { * @since 12 */ onDotConnect(callback: import('../api/@ohos.base').Callback): PatternLockAttribute; - + + /** + * Called when connecting to a grid dot. + * @param { Callback } callback - A callback instance used when connection to a grid dot. + * @returns { PatternLockAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDotConnect(callback: Callback): PatternLockAttribute; + /** * The activate circle style. * @@ -602,7 +654,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ activateCircleStyle(options: Optional): PatternLockAttribute; @@ -614,7 +667,8 @@ declare class PatternLockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ skipUnselectedPoint(skipped: boolean): PatternLockAttribute; } diff --git a/api/@internal/component/ets/plugin_component.d.ts b/api/@internal/component/ets/plugin_component.d.ts index 47db459dc188115646507bda91c92250ae90d02e..e2bf444755c735b467062d624779a91b6927ff38 100644 --- a/api/@internal/component/ets/plugin_component.d.ts +++ b/api/@internal/component/ets/plugin_component.d.ts @@ -18,13 +18,19 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common' +import { VoidCallback } from './units' +/*** endif */ + /** * PluginComponentTemplate * * @interface PluginComponentTemplate * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface PluginComponentTemplate { /** @@ -33,7 +39,8 @@ interface PluginComponentTemplate { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ source: string; /** @@ -42,7 +49,8 @@ interface PluginComponentTemplate { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; } @@ -53,7 +61,8 @@ interface PluginComponentTemplate { * @interface PluginComponentOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PluginComponentOptions { /** @@ -61,18 +70,20 @@ declare interface PluginComponentOptions { * @type { PluginComponentTemplate } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ template: PluginComponentTemplate; /** * Plugin component data. - * @type { any } + * @type { Object|undefined|null } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - data: any; + data: Object|undefined|null; } /** @@ -81,7 +92,8 @@ declare interface PluginComponentOptions { * @interface PluginErrorData * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PluginErrorData { /** @@ -89,7 +101,8 @@ declare interface PluginErrorData { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ errcode: number; @@ -98,7 +111,8 @@ declare interface PluginErrorData { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ msg: string; } @@ -114,13 +128,26 @@ declare interface PluginErrorData { */ declare type PluginErrorCallback = (info: PluginErrorData) => void; +/** + * Callback invoked when an error occurs. + * + * @typedef { function } PluginErrorCallback + * @param { PluginErrorData } info - Plugin error data + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ +type PluginErrorCallback = (info: PluginErrorData) => void + /** * Provides plugin component. * * @interface PluginComponentInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface PluginComponentInterface { /** @@ -139,7 +166,8 @@ interface PluginComponentInterface { * @returns { PluginComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ (options: PluginComponentOptions): PluginComponentAttribute; } @@ -150,7 +178,8 @@ interface PluginComponentInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ declare class PluginComponentAttribute extends CommonMethod { /** @@ -169,7 +198,8 @@ declare class PluginComponentAttribute extends CommonMethod { /** @@ -305,6 +314,20 @@ declare class PolygonAttribute extends CommonShapeMethod { * @since 11 */ points(value: Array): PolygonAttribute; + + /** + * Called when the vertex coordinate list of a polygon is set. + * + * @param { Array } value + * @returns { PolygonAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + points(value: Array): PolygonAttribute; } /** @@ -370,3 +393,30 @@ declare const Polygon: PolygonInterface; * @since 11 */ declare const PolygonInstance: PolygonAttribute; + +/** + * Provides the polygon drawing interface. + * + * @interface PolygonInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface PolygonInterface { + /** + * Called when drawing a polygon. + * + * @param { PolygonOptions } [options] - Polygon options + * @returns { PolygonAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options?: PolygonOptions): PolygonAttribute; +} diff --git a/api/@internal/component/ets/polyline.d.ts b/api/@internal/component/ets/polyline.d.ts index 76a02d6b54af5967ee710d8a62c684cd88eb5ec0..2788b19bea330f1c3d4362f0f122ee20c45c35d3 100644 --- a/api/@internal/component/ets/polyline.d.ts +++ b/api/@internal/component/ets/polyline.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonShapeMethod } from './common'; +import { ShapePoint } from './line'; +/*** endif */ + /** * Define options used to construct a polyline. * @@ -26,7 +31,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PolylineOptions { /** @@ -61,7 +67,8 @@ declare interface PolylineOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: string | number; @@ -97,7 +104,8 @@ declare interface PolylineOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: string | number } @@ -256,7 +264,8 @@ interface PolylineInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class PolylineAttribute extends CommonShapeMethod { /** @@ -298,6 +307,20 @@ declare class PolylineAttribute extends CommonShapeMethod { * @since 11 */ points(value: Array): PolylineAttribute; + + /** + * Called when the polyline is set to pass through the coordinate point list. + * + * @param { Array } value + * @returns { PolylineAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + points(value: Array): PolylineAttribute; } /** @@ -363,3 +386,30 @@ declare const Polyline: PolylineInterface; * @since 11 */ declare const PolylineInstance: PolylineAttribute; + +/** + * Provides an interface for drawing polylines. + * + * @interface PolylineInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface PolylineInterface { + /** + * Set options for polyline component. + * + * @param { PolylineOptions } [options] - Poly line options + * @returns { PolylineAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options?: PolylineOptions): PolylineAttribute; +} diff --git a/api/@internal/component/ets/progress.d.ts b/api/@internal/component/ets/progress.d.ts index e2e99faf0f6a7960d74899b73fc0772de96afd31..564f88c63996dd1d18fc8cae1e271319ef4a0b11 100644 --- a/api/@internal/component/ets/progress.d.ts +++ b/api/@internal/component/ets/progress.d.ts @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor,Length, PX , VP , LPX, Font, ResourceStr } from './units' +import { Resource } from '../../global/resource'; +import { CommonMethod, Optional,ContentModifier,CommonConfiguration } from './common' +import { LinearGradient } from './dataPanel' +import { LengthMetrics } from '../Graphics' +/*** endif */ + /** * Defines the option of Progress. * @@ -173,6 +181,58 @@ declare interface ProgressOptions { type?: Type } +/** + * Defines the option of Progress. + * + * @interface ProgressOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface ProgressOptions { + + /** + * Sets the value of Progress. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + value: number; + + /** + * Sets the total of Progress. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + total?: number; + + /** + * Sets the type of Progress. + * + * @type { ?ProgressType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type?: ProgressType +} /** * Type of progress bar * @@ -205,7 +265,8 @@ declare interface ProgressOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ProgressType { /** @@ -236,7 +297,8 @@ declare enum ProgressType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Linear = 0, @@ -268,7 +330,8 @@ declare enum ProgressType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Ring = 1, @@ -300,7 +363,8 @@ declare enum ProgressType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Eclipse = 2, @@ -332,7 +396,8 @@ declare enum ProgressType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ScaleRing = 3, @@ -364,7 +429,8 @@ declare enum ProgressType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Capsule = 4 } @@ -383,7 +449,8 @@ declare enum ProgressType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ProgressStatus { /** @@ -398,7 +465,8 @@ declare enum ProgressStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LOADING, @@ -414,7 +482,8 @@ declare enum ProgressStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PROGRESSING } @@ -455,7 +524,8 @@ declare enum ProgressStatus { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ProgressStyleOptions extends CommonProgressStyleOptions { /** @@ -490,7 +560,8 @@ declare interface ProgressStyleOptions extends CommonProgressStyleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: Length; @@ -526,7 +597,8 @@ declare interface ProgressStyleOptions extends CommonProgressStyleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scaleCount?: number; @@ -562,7 +634,8 @@ declare interface ProgressStyleOptions extends CommonProgressStyleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scaleWidth?: Length; } @@ -581,7 +654,8 @@ declare interface ProgressStyleOptions extends CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CommonProgressStyleOptions { /** @@ -600,7 +674,8 @@ declare interface CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableSmoothEffect?: boolean; } @@ -619,7 +694,8 @@ declare interface CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScanEffectOptions { /** @@ -638,7 +714,8 @@ declare interface ScanEffectOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableScanEffect?: boolean; } @@ -658,7 +735,8 @@ declare interface ScanEffectOptions { * @interface EclipseStyleOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface EclipseStyleOptions extends CommonProgressStyleOptions { @@ -680,7 +758,8 @@ declare interface EclipseStyleOptions extends CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScaleRingStyleOptions extends CommonProgressStyleOptions { /** @@ -697,7 +776,8 @@ declare interface ScaleRingStyleOptions extends CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: Length; @@ -715,7 +795,8 @@ declare interface ScaleRingStyleOptions extends CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scaleWidth?: Length; @@ -733,7 +814,8 @@ declare interface ScaleRingStyleOptions extends CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scaleCount?: number; } @@ -754,7 +836,8 @@ declare interface ScaleRingStyleOptions extends CommonProgressStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RingStyleOptions extends ScanEffectOptions, CommonProgressStyleOptions { /** @@ -771,7 +854,8 @@ declare interface RingStyleOptions extends ScanEffectOptions, CommonProgressStyl * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: Length; @@ -789,7 +873,8 @@ declare interface RingStyleOptions extends ScanEffectOptions, CommonProgressStyl * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: boolean; @@ -807,7 +892,8 @@ declare interface RingStyleOptions extends ScanEffectOptions, CommonProgressStyl * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ status?: ProgressStatus; } @@ -828,7 +914,8 @@ declare interface RingStyleOptions extends ScanEffectOptions, CommonProgressStyl * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LinearStyleOptions extends ScanEffectOptions, CommonProgressStyleOptions { /** @@ -845,7 +932,8 @@ declare interface LinearStyleOptions extends ScanEffectOptions, CommonProgressSt * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: Length; /** @@ -864,7 +952,8 @@ declare interface LinearStyleOptions extends ScanEffectOptions, CommonProgressSt * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeRadius?: PX | VP | LPX | Resource; } @@ -885,7 +974,8 @@ declare interface LinearStyleOptions extends ScanEffectOptions, CommonProgressSt * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressStyleOptions { /** @@ -902,7 +992,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderColor?: ResourceColor; @@ -920,7 +1011,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth?: Length; @@ -938,7 +1030,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ content?: string; @@ -956,7 +1049,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ font?: Font; @@ -974,7 +1068,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; @@ -994,7 +1089,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showDefaultPercentage?: boolean; @@ -1006,7 +1102,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius?: LengthMetrics; } @@ -1043,7 +1140,8 @@ declare interface CapsuleStyleOptions extends ScanEffectOptions, CommonProgressS * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ProgressStyle { /** @@ -1074,7 +1172,8 @@ declare enum ProgressStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Linear, @@ -1106,7 +1205,8 @@ declare enum ProgressStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Ring, @@ -1138,7 +1238,8 @@ declare enum ProgressStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Eclipse, @@ -1170,7 +1271,8 @@ declare enum ProgressStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ScaleRing, @@ -1202,7 +1304,8 @@ declare enum ProgressStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Capsule, } @@ -1220,7 +1323,8 @@ declare enum ProgressStyle { * @interface ProgressStyleMap * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ProgressStyleMap { /** @@ -1336,7 +1440,8 @@ declare interface ProgressStyleMap { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ProgressInterface { /** @@ -1378,6 +1483,19 @@ interface ProgressInterface { * @since 11 */ (options: ProgressOptions): ProgressAttribute; + /** + * Called when the progress bar is set. + * + * @param { ProgressOptions } options + * @returns { ProgressAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options: ProgressOptions): ProgressAttribute; } /** @@ -1546,6 +1664,7 @@ declare class ProgressAttribute): ProgressAttribute; @@ -1562,6 +1681,88 @@ declare class ProgressAttribute): ProgressAttribute; } +/** + * Defines the progress attribute functions. + * + * @extends CommonMethod + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare class ProgressAttribute extends CommonMethod { + /** + * Called when the current progress value is set. + * + * @param { number } value + * @returns { ProgressAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + value(value: number): ProgressAttribute; + + /** + * Called when the progress bar foreground is set. + * + * @param { ResourceColor | LinearGradient } value - indicates the color of the progress. + * @returns { ProgressAttribute } the attribute of the progress. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color(value: ResourceColor | LinearGradient): ProgressAttribute; + + /** + * Called when the style of progress bar is set. + * + * @param { LinearStyleOptions | RingStyleOptions | CapsuleStyleOptions | ProgressStyleOptions } value - indicates the style of the progress. + * @returns { ProgressAttribute } the attribute of the progress. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + style(value: LinearStyleOptions | RingStyleOptions | CapsuleStyleOptions | ProgressStyleOptions): ProgressAttribute; + + /** + * Sets if mark to privacy sensitive. + * + * @param { Optional } isPrivacySensitiveMode - indicates if mark to privacy sensitive. + * @returns { ProgressAttribute } the attribute of the progress. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + privacySensitive(isPrivacySensitiveMode: Optional): ProgressAttribute; + + /** + * Set the contentModifier of progress. + * + * @param { ContentModifier } modifier - The contentModifier of progress. + * @returns { ProgressAttribute } the attribute of the progress. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + contentModifier(modifier: ContentModifier): ProgressAttribute; +} + /** * ProgressConfiguration used by progress contentModifier * @@ -1570,7 +1771,8 @@ declare class ProgressAttribute { /** @@ -1580,7 +1782,8 @@ declare interface ProgressConfiguration extends CommonConfiguration { /** @@ -165,7 +185,8 @@ declare class QRCodeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color(value: ResourceColor): QRCodeAttribute; @@ -205,7 +226,8 @@ declare class QRCodeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor(value: ResourceColor): QRCodeAttribute; @@ -224,7 +246,8 @@ declare class QRCodeAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentOpacity(value: number | Resource): QRCodeAttribute; } diff --git a/api/@internal/component/ets/radio.d.ts b/api/@internal/component/ets/radio.d.ts index e104103f9693eb47145ad64c591512d63787253e..5cfb6276a3494c112402a424f02ca9f636414a15 100644 --- a/api/@internal/component/ets/radio.d.ts +++ b/api/@internal/component/ets/radio.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, ContentModifier, CommonConfiguration, Callback, Bindable } from './common'; +import { CustomBuilder } from './builder'; +import { ResourceColor } from './units'; +/*** endif */ + /** * Defines the IndicatorType of Radio component * @@ -26,7 +32,8 @@ * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RadioIndicatorType { /** @@ -36,7 +43,8 @@ declare enum RadioIndicatorType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TICK = 0, /** @@ -46,7 +54,8 @@ declare enum RadioIndicatorType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOT = 1, /** @@ -56,7 +65,8 @@ declare enum RadioIndicatorType { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CUSTOM = 2, } @@ -93,7 +103,8 @@ declare enum RadioIndicatorType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RadioOptions { /** @@ -128,7 +139,8 @@ declare interface RadioOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ group: string; @@ -164,7 +176,8 @@ declare interface RadioOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: string; /** @@ -175,7 +188,8 @@ declare interface RadioOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ indicatorType?: RadioIndicatorType; /** @@ -186,7 +200,8 @@ declare interface RadioOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ indicatorBuilder?: CustomBuilder; } @@ -206,7 +221,8 @@ declare interface RadioOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RadioStyle { /** @@ -226,7 +242,8 @@ declare interface RadioStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ checkedBackgroundColor?: ResourceColor; @@ -247,7 +264,8 @@ declare interface RadioStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ uncheckedBorderColor?: ResourceColor; @@ -268,7 +286,8 @@ declare interface RadioStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ indicatorColor?: ResourceColor; } @@ -305,7 +324,8 @@ declare interface RadioStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RadioInterface { /** @@ -344,7 +364,8 @@ interface RadioInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options: RadioOptions): RadioAttribute; } @@ -356,7 +377,8 @@ interface RadioInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnRadioChangeCallback = (isChecked: boolean) => void; @@ -392,7 +414,8 @@ declare type OnRadioChangeCallback = (isChecked: boolean) => void; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RadioAttribute extends CommonMethod { /** @@ -448,6 +471,20 @@ declare class RadioAttribute extends CommonMethod { */ checked(isChecked: Optional): RadioAttribute; + /** + * Called when the radio box is selected. + * + * @param { boolean | undefined | Bindable } isChecked + * @returns { RadioAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + checked(isChecked: boolean | undefined | Bindable): RadioAttribute; + /** * Called when the radio box selection status changes. * @@ -497,7 +534,8 @@ declare class RadioAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Optional): RadioAttribute; @@ -518,7 +556,8 @@ declare class RadioAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radioStyle(value?: RadioStyle): RadioAttribute; @@ -530,7 +569,8 @@ declare class RadioAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): RadioAttribute; @@ -542,7 +582,8 @@ declare class RadioAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: Optional>): RadioAttribute; } @@ -555,7 +596,8 @@ declare class RadioAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RadioConfiguration extends CommonConfiguration { /** @@ -565,7 +607,8 @@ declare interface RadioConfiguration extends CommonConfiguration; } diff --git a/api/@internal/component/ets/rating.d.ts b/api/@internal/component/ets/rating.d.ts index 9f7b038b974ed33df6a9960c0b4257ecdd8cb625..6ba182244448c8eb194c950533c61a62d5c5b4cb 100644 --- a/api/@internal/component/ets/rating.d.ts +++ b/api/@internal/component/ets/rating.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonConfiguration, Callback, CommonMethod, Optional, ContentModifier, Bindable } from './common' +import { ResourceStr } from './units'; +/*** endif */ + /** * Define options used to construct a rating. * @@ -26,7 +31,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RatingOptions { /** @@ -65,6 +71,19 @@ declare interface RatingOptions { */ rating: number; + /** + * Rating option. + * + * @type { number | undefined | Bindable } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + rating: number | undefined | Bindable; + /** * Indicator option. * @@ -97,7 +116,8 @@ declare interface RatingOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ indicator?: boolean } @@ -110,7 +130,8 @@ declare interface RatingOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface StarStyleOptions { /** @@ -147,7 +168,19 @@ declare interface StarStyleOptions { * @atomicservice * @since 11 */ - backgroundUri: string; + /** + * Background URI option. + * Anonymous Object Rectification. + * + * @type { ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + backgroundUri: ResourceStr; /** * Foreground URI option. @@ -183,7 +216,19 @@ declare interface StarStyleOptions { * @atomicservice * @since 11 */ - foregroundUri: string; + /** + * Foreground URI option. + * Anonymous Object Rectification. + * + * @type { ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + foregroundUri: ResourceStr; /** * Secondary URI option. @@ -219,7 +264,19 @@ declare interface StarStyleOptions { * @atomicservice * @since 11 */ - secondaryUri?: string + /** + * Secondary URI option. + * Anonymous Object Rectification. + * + * @type { ?ResourceStr } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + secondaryUri?: ResourceStr } /** @@ -254,7 +311,8 @@ declare interface StarStyleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RatingInterface { /** @@ -304,7 +362,8 @@ interface RatingInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: RatingOptions): RatingAttribute; } @@ -317,7 +376,8 @@ interface RatingInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RatingConfiguration extends CommonConfiguration { /** @@ -327,7 +387,8 @@ declare interface RatingConfiguration extends CommonConfiguration; } @@ -384,7 +449,8 @@ declare interface RatingConfiguration extends CommonConfiguration void; @@ -420,7 +486,8 @@ declare interface RatingConfiguration extends CommonConfiguration { /** @@ -459,7 +526,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stars(value: number): RatingAttribute; @@ -472,7 +540,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stars(starCount: Optional): RatingAttribute; @@ -512,7 +581,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stepSize(value: number): RatingAttribute; @@ -525,7 +595,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stepSize(size: Optional): RatingAttribute; @@ -576,7 +647,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ starStyle(options: StarStyleOptions): RatingAttribute; @@ -589,7 +661,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ starStyle(options: Optional): RatingAttribute; @@ -642,7 +715,8 @@ declare class RatingAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Optional): RatingAttribute; @@ -654,7 +728,8 @@ declare class RatingAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): RatingAttribute; @@ -666,7 +741,8 @@ declare class RatingAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: Optional>): RatingAttribute; } diff --git a/api/@internal/component/ets/rect.d.ts b/api/@internal/component/ets/rect.d.ts index e1f1784e6da36a45d7baa3fbe74c982c711c16b2..32728400b62e11ffb6dbd05d930b2d019feb3add 100644 --- a/api/@internal/component/ets/rect.d.ts +++ b/api/@internal/component/ets/rect.d.ts @@ -18,6 +18,24 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonShapeMethod } from './common'; +import { Length } from './units'; +/*** endif */ + +/** + * Defines the RadiusItem, the first element is the width of the rounded corner, the second is the height of the rounded corner. + * + * @typedef { [Length, Length] } RadiusItem + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type RadiusItem = [Length, Length]; + /** * Define options used to construct a rectangle. * @@ -26,7 +44,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RectOptions { /** @@ -63,7 +82,29 @@ declare interface RectOptions { * @atomicservice * @since 11 */ - width?: number | string; + /** + * Rectangle width. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ + /** + * Rectangle width. + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + width?: Length; /** * Rectangle height. @@ -99,7 +140,29 @@ declare interface RectOptions { * @atomicservice * @since 11 */ - height?: number | string; + /** + * Rectangle height. + * Anonymous Object Rectification. + * + * @type { ?(number | string) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 18 + */ + /** + * Rectangle height. + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + height?: Length; /** * Corner radius of the rectangle. @@ -136,6 +199,19 @@ declare interface RectOptions { * @since 11 */ radius?: number | string | Array; + + /** + * Corner radius of the rectangle. + * + * @type { ?(Length | Array) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + radius?: Length | Array; } /** @@ -146,7 +222,8 @@ declare interface RectOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RoundedRectOptions { /** @@ -181,7 +258,8 @@ declare interface RoundedRectOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: number | string; @@ -217,7 +295,8 @@ declare interface RoundedRectOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number | string; @@ -253,7 +332,8 @@ declare interface RoundedRectOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radiusWidth?: number | string; @@ -289,7 +369,8 @@ declare interface RoundedRectOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radiusHeight?: number | string; } @@ -472,7 +553,8 @@ interface RectInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RectAttribute extends CommonShapeMethod { /** @@ -511,7 +593,8 @@ declare class RectAttribute extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radiusWidth(value: number | string): RectAttribute; @@ -551,7 +634,8 @@ declare class RectAttribute extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ radiusHeight(value: number | string): RectAttribute; @@ -594,6 +678,20 @@ declare class RectAttribute extends CommonShapeMethod { * @since 11 */ radius(value: number | string | Array): RectAttribute; + + /** + * Called when the fillet size is set. + * + * @param { number | string | Array } value + * @returns { RectAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + radius(value: number | string | Array): RectAttribute; } /** @@ -652,3 +750,32 @@ declare const RectInStance: RectAttribute; * @since 11 */ declare const RectInstance: RectAttribute; + +/** + * Provides an interface for drawing rectangles. + * + * @interface RectInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface RectInterface { + /** + * Called when a rectangle is created. + * + * @param { RectOptions | RoundedRectOptions } [options] - Rect options + * @returns { RectAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + ( + options?: RectOptions | RoundedRectOptions, + ): RectAttribute; +} \ No newline at end of file diff --git a/api/@internal/component/ets/refresh.d.ts b/api/@internal/component/ets/refresh.d.ts index 592efa7b41d7abb0ad7535789da6c95b5f913303..8cb9cfd8dfd5db1485528d64c210a12f8a4db1d7 100644 --- a/api/@internal/component/ets/refresh.d.ts +++ b/api/@internal/component/ets/refresh.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Callback, Optional, CommonMethod } from './common' +import { CustomBuilder } from './builder' +import { ResourceStr } from './units' +import { ComponentContent } from '../ComponentContent' +/*** endif */ + /** * The refresh status of the drop-down refresh. * @@ -40,7 +47,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RefreshStatus { /** @@ -62,7 +70,8 @@ declare enum RefreshStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Inactive, @@ -85,7 +94,8 @@ declare enum RefreshStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Drag, @@ -108,7 +118,8 @@ declare enum RefreshStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OverDrag, @@ -131,7 +142,8 @@ declare enum RefreshStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Refresh, @@ -154,7 +166,8 @@ declare enum RefreshStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Done, } @@ -181,7 +194,8 @@ declare enum RefreshStatus { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RefreshOptions { /** @@ -209,7 +223,8 @@ interface RefreshOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ refreshing: boolean; @@ -266,7 +281,8 @@ interface RefreshOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ promptText?: ResourceStr; @@ -285,7 +301,8 @@ interface RefreshOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ builder?: CustomBuilder; @@ -296,7 +313,8 @@ interface RefreshOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ refreshingContent?: ComponentContent; } @@ -323,7 +341,8 @@ interface RefreshOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RefreshInterface { /** @@ -351,7 +370,8 @@ interface RefreshInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: RefreshOptions): RefreshAttribute; } @@ -378,7 +398,8 @@ interface RefreshInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RefreshAttribute extends CommonMethod { /** @@ -406,7 +427,8 @@ declare class RefreshAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onStateChange(callback: (state: RefreshStatus) => void): RefreshAttribute; @@ -435,7 +457,8 @@ declare class RefreshAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onRefreshing(callback: () => void): RefreshAttribute; @@ -447,7 +470,8 @@ declare class RefreshAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ refreshOffset(value: number): RefreshAttribute; @@ -459,7 +483,8 @@ declare class RefreshAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pullToRefresh(value: boolean): RefreshAttribute; @@ -472,7 +497,8 @@ declare class RefreshAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onOffsetChange(callback: Callback): RefreshAttribute; @@ -484,7 +510,8 @@ declare class RefreshAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pullDownRatio(ratio: Optional): RefreshAttribute; } diff --git a/api/@internal/component/ets/relative_container.d.ts b/api/@internal/component/ets/relative_container.d.ts index cd67f313f5e676b8592ebd42beae25bc6c1555b5..1caa3043b68934d16bf5ec1ef5bcedb3f9cce0a1 100644 --- a/api/@internal/component/ets/relative_container.d.ts +++ b/api/@internal/component/ets/relative_container.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Dimension } from './units'; +import { Axis } from './enums'; +import { CommonMethod } from './common'; +/*** endif */ + /** * Provides ports for relative containers. * @@ -43,7 +49,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RelativeContainerInterface { /** @@ -71,7 +78,8 @@ interface RelativeContainerInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): RelativeContainerAttribute; } @@ -83,7 +91,8 @@ interface RelativeContainerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GuideLinePosition { /** @@ -93,7 +102,8 @@ declare interface GuideLinePosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start? : Dimension; @@ -104,7 +114,8 @@ declare interface GuideLinePosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end? : Dimension; } @@ -116,7 +127,8 @@ declare interface GuideLinePosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GuideLineStyle { /** @@ -126,7 +138,8 @@ declare interface GuideLineStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id : string; @@ -137,7 +150,8 @@ declare interface GuideLineStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ direction : Axis; @@ -148,7 +162,8 @@ declare interface GuideLineStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position : GuideLinePosition; } @@ -160,7 +175,8 @@ declare interface GuideLineStyle { * @syscap SystemCapability.Test.UiTest * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BarrierDirection { /** @@ -169,7 +185,8 @@ declare enum BarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LEFT, @@ -179,7 +196,8 @@ declare enum BarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT, @@ -189,7 +207,8 @@ declare enum BarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP, @@ -199,7 +218,8 @@ declare enum BarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM, } @@ -211,7 +231,8 @@ declare enum BarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LocalizedBarrierDirection { /** @@ -220,7 +241,8 @@ declare enum LocalizedBarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START = 0, @@ -230,7 +252,8 @@ declare enum LocalizedBarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END = 1, @@ -240,7 +263,8 @@ declare enum LocalizedBarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP = 2, @@ -250,7 +274,8 @@ declare enum LocalizedBarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOTTOM = 3, } @@ -262,7 +287,8 @@ declare enum LocalizedBarrierDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BarrierStyle { /** @@ -272,7 +298,8 @@ declare interface BarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id : string; @@ -283,7 +310,8 @@ declare interface BarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ direction : BarrierDirection; @@ -294,7 +322,8 @@ declare interface BarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ referencedId : Array; } @@ -306,7 +335,8 @@ declare interface BarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedBarrierStyle { /** @@ -316,7 +346,8 @@ declare interface LocalizedBarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id : string; @@ -327,7 +358,8 @@ declare interface LocalizedBarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ localizedDirection : LocalizedBarrierDirection; @@ -338,7 +370,8 @@ declare interface LocalizedBarrierStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ referencedId : Array; } @@ -362,7 +395,8 @@ declare interface LocalizedBarrierStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RelativeContainerAttribute extends CommonMethod { /** @@ -373,7 +407,8 @@ declare class RelativeContainerAttribute extends CommonMethod): RelativeContainerAttribute; @@ -385,7 +420,8 @@ declare class RelativeContainerAttribute extends CommonMethod): RelativeContainerAttribute; @@ -397,7 +433,8 @@ declare class RelativeContainerAttribute extends CommonMethod): RelativeContainerAttribute; } diff --git a/api/@internal/component/ets/remote_window.d.ts b/api/@internal/component/ets/remote_window.d.ts index 97f7b030b67026f700320961466df2ee9a6971d5..e0daccbb03c60e893cb8015f501a1a5304afc45b 100644 --- a/api/@internal/component/ets/remote_window.d.ts +++ b/api/@internal/component/ets/remote_window.d.ts @@ -17,21 +17,25 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +/*** endif */ /** * Round rect. * * @interface RRect * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface RRect { /** * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ left: number; @@ -39,7 +43,8 @@ interface RRect { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ top: number; @@ -47,7 +52,8 @@ interface RRect { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -55,7 +61,8 @@ interface RRect { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -63,7 +70,8 @@ interface RRect { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ radius: number; } @@ -74,7 +82,8 @@ interface RRect { * @interface WindowAnimationTarget * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface WindowAnimationTarget { /** @@ -82,7 +91,8 @@ interface WindowAnimationTarget { * @readonly * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly bundleName: string; @@ -91,7 +101,8 @@ interface WindowAnimationTarget { * @readonly * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly abilityName: string; @@ -100,7 +111,8 @@ interface WindowAnimationTarget { * @readonly * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly windowBounds: RRect; @@ -109,7 +121,8 @@ interface WindowAnimationTarget { * @readonly * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly missionId: number; } @@ -120,7 +133,8 @@ interface WindowAnimationTarget { * @interface RemoteWindowInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface RemoteWindowInterface { /** @@ -130,7 +144,8 @@ interface RemoteWindowInterface { * @returns { RemoteWindowAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ (target: WindowAnimationTarget): RemoteWindowAttribute; } @@ -141,7 +156,8 @@ interface RemoteWindowInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RemoteWindowAttribute extends CommonMethod {} diff --git a/api/@internal/component/ets/rich_editor.d.ts b/api/@internal/component/ets/rich_editor.d.ts index 3ef4e32d0d56dd91f90c239df7b806c0587f9f7e..e59b9deac8eb5071a788590a24b1089dbfd2164f 100644 --- a/api/@internal/component/ets/rich_editor.d.ts +++ b/api/@internal/component/ets/rich_editor.d.ts @@ -18,6 +18,21 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ShadowOptions, ClickEvent, SelectionOptions, CommonMethod, Callback, HapticFeedbackMode, RectResult, HoverEvent, PixelMap } from './common'; +import { CustomBuilder } from './builder'; +import { ResourceColor, Length, ResourceStr, Dimension, Margin, BorderRadiuses, Font, VoidCallback } from './units'; +import { FontStyle, FontWeight, TextAlign, WordBreak, LineBreakStrategy, ImageSpanAlignment, ImageFit, ResponseType, CopyOptions, BarState } from './enums'; +import { DecorationStyleInterface, StyledString, MutableStyledString } from './styledString'; +import { Resource } from './../../../api/global/resource'; +import { SymbolEffectStrategy, SymbolRenderingStrategy } from './symbolglyph'; +import { DecorationStyleResult, TextRange, MenuType, TextEditControllerEx, LayoutManager, PreviewText, StyledStringController, StyledStringChangedListener, TextDataDetectorConfig, OnDidChangeCallback, EditMenuOptions, KeyboardAppearance } from './textCommon'; +import { GestureEvent } from './gesture'; +import { EnterKeyType, SubmitEvent } from './textInput'; +import { LengthMetrics , ColorMetrics } from '../Graphics'; +import { TextBackgroundStyle } from "./span"; +/*** endif */ + /** * Defines delete text direction. * @@ -32,7 +47,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RichEditorDeleteDirection { /** @@ -47,7 +63,8 @@ declare enum RichEditorDeleteDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BACKWARD, @@ -63,7 +80,8 @@ declare enum RichEditorDeleteDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FORWARD, } @@ -82,7 +100,8 @@ declare enum RichEditorDeleteDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RichEditorSpanType { /** @@ -97,7 +116,8 @@ declare enum RichEditorSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT = 0, @@ -113,7 +133,8 @@ declare enum RichEditorSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1, @@ -129,7 +150,8 @@ declare enum RichEditorSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MIXED = 2, @@ -139,7 +161,8 @@ declare enum RichEditorSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BUILDER = 3, @@ -149,7 +172,8 @@ declare enum RichEditorSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 4, } @@ -169,7 +193,8 @@ declare enum RichEditorSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RichEditorResponseType { /** @@ -185,7 +210,8 @@ declare enum RichEditorResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT_CLICK = 0, @@ -202,7 +228,8 @@ declare enum RichEditorResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LONG_PRESS = 1, @@ -219,7 +246,8 @@ declare enum RichEditorResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SELECT = 2, @@ -229,7 +257,8 @@ declare enum RichEditorResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 3, } @@ -248,7 +277,8 @@ declare enum RichEditorResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorSpanPosition { /** @@ -265,7 +295,8 @@ declare interface RichEditorSpanPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spanIndex: number; @@ -283,7 +314,8 @@ declare interface RichEditorSpanPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spanRange: [number, number]; } @@ -302,7 +334,8 @@ declare interface RichEditorSpanPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorTextStyle { /** @@ -319,7 +352,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; @@ -337,7 +371,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: Length | number; @@ -355,7 +390,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle?: FontStyle; @@ -373,7 +409,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: number | FontWeight | string; @@ -391,7 +428,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily?: ResourceStr; @@ -418,7 +456,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration?: DecorationStyleInterface; @@ -437,7 +476,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textShadow?: ShadowOptions | Array; @@ -448,7 +488,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing?: number | string; @@ -459,7 +500,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight?: number | string | Resource; @@ -470,7 +512,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading?: boolean; @@ -486,7 +529,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature?: string; @@ -497,7 +541,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ textBackgroundStyle?: TextBackgroundStyle; } @@ -518,7 +563,8 @@ declare interface RichEditorTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LeadingMarginPlaceholder { /** @@ -536,7 +582,8 @@ declare interface LeadingMarginPlaceholder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pixelMap: PixelMap; @@ -555,7 +602,8 @@ declare interface LeadingMarginPlaceholder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size: [Dimension, Dimension]; } @@ -575,7 +623,8 @@ declare interface LeadingMarginPlaceholder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorParagraphStyle { /** @@ -593,7 +642,8 @@ declare interface RichEditorParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textAlign?: TextAlign; @@ -612,7 +662,8 @@ declare interface RichEditorParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ leadingMargin?: Dimension | LeadingMarginPlaceholder; @@ -623,7 +674,8 @@ declare interface RichEditorParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak?: WordBreak; @@ -634,7 +686,8 @@ declare interface RichEditorParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineBreakStrategy?: LineBreakStrategy; @@ -645,7 +698,8 @@ declare interface RichEditorParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ paragraphSpacing?: number; } @@ -657,7 +711,8 @@ declare interface RichEditorParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PasteEvent { /** @@ -676,7 +731,8 @@ declare interface PasteEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preventDefault?: Callback; } @@ -695,7 +751,8 @@ declare interface PasteEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorTextSpan { /** @@ -712,7 +769,8 @@ declare interface RichEditorTextSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spanPosition: RichEditorSpanPosition; @@ -730,7 +788,8 @@ declare interface RichEditorTextSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: string; @@ -748,7 +807,8 @@ declare interface RichEditorTextSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle?: RichEditorTextStyle; } @@ -768,7 +828,8 @@ declare interface RichEditorTextSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RichEditorLayoutStyle { /** @@ -786,7 +847,8 @@ interface RichEditorLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: Dimension | Margin; @@ -805,7 +867,8 @@ interface RichEditorLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius?: Dimension | BorderRadiuses; } @@ -824,7 +887,8 @@ interface RichEditorLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorImageSpanStyle { /** @@ -841,7 +905,8 @@ declare interface RichEditorImageSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size?: [Dimension, Dimension]; @@ -859,7 +924,8 @@ declare interface RichEditorImageSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ verticalAlign?: ImageSpanAlignment; @@ -877,7 +943,8 @@ declare interface RichEditorImageSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit?: ImageFit; @@ -896,7 +963,8 @@ declare interface RichEditorImageSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ layoutStyle?: RichEditorLayoutStyle; } @@ -916,7 +984,8 @@ declare interface RichEditorImageSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorSymbolSpanStyle { /** @@ -934,7 +1003,8 @@ declare interface RichEditorSymbolSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: number | string | Resource; @@ -953,7 +1023,8 @@ declare interface RichEditorSymbolSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: Array; @@ -972,7 +1043,8 @@ declare interface RichEditorSymbolSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: number | FontWeight | string; @@ -991,7 +1063,8 @@ declare interface RichEditorSymbolSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ effectStrategy?: SymbolEffectStrategy; @@ -1010,7 +1083,8 @@ declare interface RichEditorSymbolSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderingStrategy?: SymbolRenderingStrategy; } @@ -1029,7 +1103,8 @@ declare interface RichEditorSymbolSpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorTextStyleResult { /** @@ -1046,7 +1121,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor: ResourceColor; @@ -1064,7 +1140,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize: number; @@ -1082,7 +1159,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle: FontStyle; @@ -1100,7 +1178,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight: number; @@ -1118,7 +1197,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily: string; @@ -1145,7 +1225,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration: DecorationStyleResult; @@ -1156,7 +1237,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textShadow?: Array; @@ -1167,7 +1249,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing?: number; @@ -1178,7 +1261,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight?: number; @@ -1189,7 +1273,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading?: boolean; @@ -1205,7 +1290,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature?: string; @@ -1216,7 +1302,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ textBackgroundStyle?: TextBackgroundStyle; } @@ -1236,7 +1323,8 @@ declare interface RichEditorTextStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorParagraphResult { /** @@ -1254,7 +1342,8 @@ declare interface RichEditorParagraphResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style: RichEditorParagraphStyle; @@ -1273,7 +1362,8 @@ declare interface RichEditorParagraphResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ range: [number, number]; } @@ -1293,7 +1383,8 @@ declare interface RichEditorParagraphResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorSymbolSpanStyleResult { /** @@ -1311,7 +1402,8 @@ declare interface RichEditorSymbolSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize: number | string | Resource; @@ -1330,7 +1422,8 @@ declare interface RichEditorSymbolSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor: Array; @@ -1349,7 +1442,8 @@ declare interface RichEditorSymbolSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight: number | FontWeight | string; @@ -1368,7 +1462,8 @@ declare interface RichEditorSymbolSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ effectStrategy: SymbolEffectStrategy; @@ -1387,7 +1482,8 @@ declare interface RichEditorSymbolSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderingStrategy: SymbolRenderingStrategy; } @@ -1406,7 +1502,8 @@ declare interface RichEditorSymbolSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorTextSpanResult { /** @@ -1423,7 +1520,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spanPosition: RichEditorSpanPosition; @@ -1441,7 +1539,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: string; @@ -1459,7 +1558,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle: RichEditorTextStyleResult; @@ -1477,7 +1577,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetInSpan: [number, number]; @@ -1496,7 +1597,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolSpanStyle?: RichEditorSymbolSpanStyle; @@ -1515,7 +1617,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ valueResource?: Resource; @@ -1526,7 +1629,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ paragraphStyle?: RichEditorParagraphStyle; @@ -1537,7 +1641,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ previewText?: string; @@ -1548,7 +1653,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ urlStyle?: RichEditorUrlStyle; } @@ -1567,7 +1673,8 @@ declare interface RichEditorTextSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorImageSpanStyleResult { /** @@ -1584,7 +1691,8 @@ declare interface RichEditorImageSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size: [number, number]; @@ -1602,7 +1710,8 @@ declare interface RichEditorImageSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ verticalAlign: ImageSpanAlignment; @@ -1620,7 +1729,8 @@ declare interface RichEditorImageSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit: ImageFit; @@ -1631,7 +1741,8 @@ declare interface RichEditorImageSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ layoutStyle?: RichEditorLayoutStyle; } @@ -1650,7 +1761,8 @@ declare interface RichEditorImageSpanStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorImageSpanResult { /** @@ -1667,7 +1779,8 @@ declare interface RichEditorImageSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spanPosition: RichEditorSpanPosition; @@ -1685,7 +1798,8 @@ declare interface RichEditorImageSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ valuePixelMap?: PixelMap; @@ -1703,7 +1817,8 @@ declare interface RichEditorImageSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ valueResourceStr?: ResourceStr; @@ -1721,7 +1836,8 @@ declare interface RichEditorImageSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ imageStyle: RichEditorImageSpanStyleResult; @@ -1739,7 +1855,8 @@ declare interface RichEditorImageSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetInSpan: [number, number]; } @@ -1758,7 +1875,8 @@ declare interface RichEditorImageSpanResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorImageSpan { /** @@ -1775,7 +1893,8 @@ declare interface RichEditorImageSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spanPosition: RichEditorSpanPosition; @@ -1793,7 +1912,8 @@ declare interface RichEditorImageSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: PixelMap | ResourceStr; @@ -1811,7 +1931,8 @@ declare interface RichEditorImageSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ imageStyle?: RichEditorImageSpanStyle; } @@ -1830,7 +1951,8 @@ declare interface RichEditorImageSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorRange { /** @@ -1849,7 +1971,8 @@ declare interface RichEditorRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ start?: number; @@ -1869,7 +1992,8 @@ declare interface RichEditorRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ end?: number; } @@ -1889,7 +2013,8 @@ declare interface RichEditorRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorGesture { /** @@ -1907,7 +2032,8 @@ declare interface RichEditorGesture { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onClick?: Callback; @@ -1926,7 +2052,8 @@ declare interface RichEditorGesture { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onLongPress?: Callback; @@ -1937,7 +2064,8 @@ declare interface RichEditorGesture { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onDoubleClick?: Callback; } @@ -1956,7 +2084,8 @@ declare interface RichEditorGesture { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorTextSpanOptions { /** @@ -1973,7 +2102,8 @@ declare interface RichEditorTextSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: number; @@ -1991,7 +2121,8 @@ declare interface RichEditorTextSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: RichEditorTextStyle; @@ -2010,7 +2141,8 @@ declare interface RichEditorTextSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ paragraphStyle?: RichEditorParagraphStyle; @@ -2029,7 +2161,8 @@ declare interface RichEditorTextSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ gesture?: RichEditorGesture; @@ -2040,7 +2173,8 @@ declare interface RichEditorTextSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ urlStyle?: RichEditorUrlStyle; } @@ -2052,7 +2186,8 @@ declare interface RichEditorTextSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface KeyboardOptions { /** @@ -2062,7 +2197,8 @@ declare interface KeyboardOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ supportAvoidance?: boolean; } @@ -2081,7 +2217,8 @@ declare interface KeyboardOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorImageSpanOptions { /** @@ -2098,7 +2235,8 @@ declare interface RichEditorImageSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: number; @@ -2116,7 +2254,8 @@ declare interface RichEditorImageSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ imageStyle?: RichEditorImageSpanStyle; @@ -2135,7 +2274,8 @@ declare interface RichEditorImageSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ gesture?: RichEditorGesture; @@ -2146,7 +2286,8 @@ declare interface RichEditorImageSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onHover?: OnHoverCallback; } @@ -2166,7 +2307,8 @@ declare interface RichEditorImageSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorBuilderSpanOptions { /** @@ -2184,7 +2326,8 @@ declare interface RichEditorBuilderSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: number; @@ -2194,7 +2337,8 @@ declare interface RichEditorBuilderSpanOptions { * @type { ?ColorMetrics } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ dragBackgroundColor? : ColorMetrics; @@ -2204,7 +2348,8 @@ declare interface RichEditorBuilderSpanOptions { * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ isDragShadowNeeded?: boolean; } @@ -2216,7 +2361,8 @@ declare interface RichEditorBuilderSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PlaceholderStyle { /** @@ -2226,7 +2372,8 @@ declare interface PlaceholderStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ font?: Font; @@ -2237,7 +2384,8 @@ declare interface PlaceholderStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; } @@ -2258,7 +2406,8 @@ declare interface PlaceholderStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorSpanStyleOptions extends RichEditorRange { } @@ -2279,7 +2428,8 @@ declare interface RichEditorSpanStyleOptions extends RichEditorRange { } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorParagraphStyleOptions extends RichEditorRange { /** @@ -2297,7 +2447,8 @@ declare interface RichEditorParagraphStyleOptions extends RichEditorRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style: RichEditorParagraphStyle; } @@ -2318,7 +2469,8 @@ declare interface RichEditorParagraphStyleOptions extends RichEditorRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanStyleOptions { /** @@ -2335,7 +2487,8 @@ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanSty * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle: RichEditorTextStyle; @@ -2346,7 +2499,8 @@ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanSty * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ urlStyle?: RichEditorUrlStyle; } @@ -2367,7 +2521,8 @@ declare interface RichEditorUpdateTextSpanStyleOptions extends RichEditorSpanSty * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorUpdateImageSpanStyleOptions extends RichEditorSpanStyleOptions { /** @@ -2384,7 +2539,8 @@ declare interface RichEditorUpdateImageSpanStyleOptions extends RichEditorSpanSt * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ imageStyle: RichEditorImageSpanStyle; } @@ -2406,7 +2562,8 @@ declare interface RichEditorUpdateImageSpanStyleOptions extends RichEditorSpanSt * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanStyleOptions { /** @@ -2424,7 +2581,8 @@ declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolStyle: RichEditorSymbolSpanStyle; } @@ -2444,7 +2602,8 @@ declare interface RichEditorUpdateSymbolSpanStyleOptions extends RichEditorSpanS * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorSymbolSpanOptions { /** @@ -2462,7 +2621,8 @@ declare interface RichEditorSymbolSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: number; @@ -2481,7 +2641,8 @@ declare interface RichEditorSymbolSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: RichEditorSymbolSpanStyle; } @@ -2500,7 +2661,8 @@ declare interface RichEditorSymbolSpanOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorSelection { /** @@ -2517,7 +2679,8 @@ declare interface RichEditorSelection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selection: [number, number]; @@ -2535,7 +2698,8 @@ declare interface RichEditorSelection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ spans: Array; } @@ -2554,7 +2718,8 @@ declare interface RichEditorSelection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorInsertValue { /** @@ -2571,7 +2736,8 @@ declare interface RichEditorInsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ insertOffset: number; @@ -2589,7 +2755,8 @@ declare interface RichEditorInsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ insertValue: string; @@ -2600,7 +2767,8 @@ declare interface RichEditorInsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ previewText?: string; } @@ -2619,7 +2787,8 @@ declare interface RichEditorInsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorDeleteValue { /** @@ -2636,7 +2805,8 @@ declare interface RichEditorDeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; @@ -2654,7 +2824,8 @@ declare interface RichEditorDeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction: RichEditorDeleteDirection; @@ -2672,7 +2843,8 @@ declare interface RichEditorDeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ length: number; @@ -2690,7 +2862,8 @@ declare interface RichEditorDeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ richEditorDeleteSpans: Array; } @@ -2702,7 +2875,8 @@ declare interface RichEditorDeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorChangeValue { /** @@ -2712,7 +2886,8 @@ declare interface RichEditorChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rangeBefore: TextRange; @@ -2723,7 +2898,8 @@ declare interface RichEditorChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacedSpans: Array; @@ -2734,7 +2910,8 @@ declare interface RichEditorChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacedImageSpans: Array; @@ -2745,7 +2922,8 @@ declare interface RichEditorChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacedSymbolSpans: Array; } @@ -2764,7 +2942,8 @@ declare interface RichEditorChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorOptions { /** @@ -2781,7 +2960,8 @@ declare interface RichEditorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ controller: RichEditorController; } @@ -2793,7 +2973,8 @@ declare interface RichEditorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorStyledStringOptions { /** @@ -2803,7 +2984,8 @@ declare interface RichEditorStyledStringOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ controller: RichEditorStyledStringController; } @@ -2823,7 +3005,8 @@ declare interface RichEditorStyledStringOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SelectionMenuOptions { /** @@ -2850,7 +3033,8 @@ declare interface SelectionMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onAppear?: MenuOnAppearCallback; @@ -2882,6 +3066,18 @@ declare interface SelectionMenuOptions { */ onDisappear?: Callback; + /** + * Callback function when the selection menu disappears. + * + * @type { ?VoidCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDisappear?: VoidCallback; + /** * Menu type, default value is MenuType.SELECTION_MENU. * @@ -2889,7 +3085,8 @@ declare interface SelectionMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ menuType?: MenuType; @@ -2900,7 +3097,8 @@ declare interface SelectionMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onMenuShow?: MenuCallback; @@ -2911,7 +3109,8 @@ declare interface SelectionMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onMenuHide?: MenuCallback; @@ -2921,7 +3120,8 @@ declare interface SelectionMenuOptions { * @type { ?PreviewMenuOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ previewMenuOptions?: PreviewMenuOptions; } @@ -2932,7 +3132,8 @@ declare interface SelectionMenuOptions { * @interface PreviewMenuOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PreviewMenuOptions { /** @@ -2941,7 +3142,8 @@ declare interface PreviewMenuOptions { * @type { ?HapticFeedbackMode } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ hapticFeedbackMode? : HapticFeedbackMode; } @@ -2953,7 +3155,8 @@ declare interface PreviewMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RichEditorBaseController implements TextEditControllerEx { /** @@ -2970,7 +3173,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getCaretOffset(): number; @@ -2990,7 +3194,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setCaretOffset(offset: number): boolean; @@ -3006,7 +3211,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ closeSelectionMenu(): void; @@ -3025,7 +3231,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getTypingStyle(): RichEditorTextStyle; @@ -3044,7 +3251,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setTypingStyle(value: RichEditorTextStyle): void; @@ -3066,7 +3274,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; @@ -3077,7 +3286,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isEditing(): boolean; @@ -3087,7 +3297,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stopEditing(): void; @@ -3098,7 +3309,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLayoutManager(): LayoutManager; @@ -3109,7 +3321,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getPreviewText(): PreviewText; @@ -3120,7 +3333,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ getCaretRect(): RectResult | undefined; } @@ -3146,7 +3360,8 @@ declare class RichEditorBaseController implements TextEditControllerEx { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RichEditorController extends RichEditorBaseController { /** @@ -3167,7 +3382,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addTextSpan(value: string, options?: RichEditorTextSpanOptions): number; @@ -3189,7 +3405,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addImageSpan(value: PixelMap | ResourceStr, options?: RichEditorImageSpanOptions): number; @@ -3212,7 +3429,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ addBuilderSpan(value: CustomBuilder, options?: RichEditorBuilderSpanOptions): number; @@ -3235,7 +3453,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ addSymbolSpan(value: Resource, options?: RichEditorSymbolSpanOptions ): number; @@ -3253,7 +3472,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ updateSpanStyle(value: RichEditorUpdateTextSpanStyleOptions | RichEditorUpdateImageSpanStyleOptions | RichEditorUpdateSymbolSpanStyleOptions): void; @@ -3272,7 +3492,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ updateParagraphStyle(value: RichEditorParagraphStyleOptions): void; @@ -3290,7 +3511,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ deleteSpans(value?: RichEditorRange): void; @@ -3310,7 +3532,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getSpans(value?: RichEditorRange): Array; @@ -3331,7 +3554,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getParagraphs(value?: RichEditorRange): Array; @@ -3350,7 +3574,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getSelection(): RichEditorSelection; @@ -3364,7 +3589,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fromStyledString(value: StyledString): Array; @@ -3378,7 +3604,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ toStyledString(value: RichEditorRange): StyledString; } @@ -3390,7 +3617,8 @@ declare class RichEditorController extends RichEditorBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type RichEditorSpan = RichEditorImageSpanResult | RichEditorTextSpanResult; @@ -3402,7 +3630,8 @@ declare type RichEditorSpan = RichEditorImageSpanResult | RichEditorTextSpanResu * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RichEditorStyledStringController extends RichEditorBaseController implements StyledStringController { /** @@ -3412,7 +3641,8 @@ declare class RichEditorStyledStringController extends RichEditorBaseController * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setStyledString(styledString: StyledString): void; @@ -3422,7 +3652,8 @@ declare class RichEditorStyledStringController extends RichEditorBaseController * @returns { MutableStyledString } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getStyledString(): MutableStyledString; @@ -3433,7 +3664,8 @@ declare class RichEditorStyledStringController extends RichEditorBaseController * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getSelection(): RichEditorRange; @@ -3444,7 +3676,8 @@ declare class RichEditorStyledStringController extends RichEditorBaseController * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onContentChanged(listener: StyledStringChangedListener): void; } @@ -3463,7 +3696,8 @@ declare class RichEditorStyledStringController extends RichEditorBaseController * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RichEditorAttribute extends CommonMethod { /** @@ -3492,7 +3726,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onReady(callback: Callback): RichEditorAttribute; @@ -3522,7 +3757,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSelect(callback: Callback): RichEditorAttribute; @@ -3534,7 +3770,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSelectionChange(callback: Callback): RichEditorAttribute; @@ -3564,7 +3801,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ aboutToIMEInput(callback: Callback): RichEditorAttribute; @@ -3594,7 +3832,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onIMEInputComplete(callback: Callback): RichEditorAttribute; @@ -3606,7 +3845,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidIMEInput(callback: Callback): RichEditorAttribute; @@ -3636,7 +3876,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ aboutToDelete(callback: Callback): RichEditorAttribute; @@ -3666,7 +3907,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDeleteComplete(callback: Callback): RichEditorAttribute; @@ -3687,7 +3929,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ copyOptions(value: CopyOptions): RichEditorAttribute; @@ -3714,7 +3957,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bindSelectionMenu(spanType: RichEditorSpanType, content: CustomBuilder, responseType: ResponseType | RichEditorResponseType, options?: SelectionMenuOptions): RichEditorAttribute; @@ -3746,7 +3990,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customKeyboard(value: CustomBuilder, options?: KeyboardOptions): RichEditorAttribute; @@ -3767,7 +4012,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onPaste(callback: PasteEventCallback): RichEditorAttribute; @@ -3788,7 +4034,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableDataDetector(enable: boolean): RichEditorAttribute; @@ -3800,7 +4047,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enablePreviewText(enable: boolean): RichEditorAttribute; @@ -3821,7 +4069,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dataDetectorConfig(config: TextDataDetectorConfig): RichEditorAttribute; @@ -3834,7 +4083,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ placeholder(value: ResourceStr, style?: PlaceholderStyle): RichEditorAttribute; @@ -3846,7 +4096,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ caretColor(value: ResourceColor): RichEditorAttribute; @@ -3858,7 +4109,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectedBackgroundColor(value: ResourceColor): RichEditorAttribute; @@ -3870,7 +4122,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onEditingChange(callback: Callback): RichEditorAttribute; @@ -3882,7 +4135,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType(value: EnterKeyType): RichEditorAttribute; @@ -3894,7 +4148,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSubmit(callback: SubmitCallback): RichEditorAttribute; @@ -3906,7 +4161,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillChange(callback: Callback) : RichEditorAttribute; @@ -3918,7 +4174,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidChange(callback: OnDidChangeCallback) : RichEditorAttribute; @@ -3930,7 +4187,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onCut(callback: Callback): RichEditorAttribute; @@ -3942,7 +4200,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onCopy(callback: Callback): RichEditorAttribute; @@ -3954,7 +4213,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ editMenuOptions(editMenu: EditMenuOptions): RichEditorAttribute; @@ -3966,7 +4226,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableKeyboardOnFocus(isEnabled: boolean): RichEditorAttribute; @@ -3978,7 +4239,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(isEnabled: boolean): RichEditorAttribute; @@ -3990,7 +4252,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ barState(state: BarState): RichEditorAttribute; @@ -4002,7 +4265,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ maxLength(maxLength: Optional): RichEditorAttribute; @@ -4014,7 +4278,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ maxLines(maxLines: Optional): RichEditorAttribute; @@ -4025,7 +4290,8 @@ declare class RichEditorAttribute extends CommonMethod { * @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAppearance(appearance: Optional): RichEditorAttribute; @@ -4036,7 +4302,8 @@ declare class RichEditorAttribute extends CommonMethod { * @returns { RichEditorAttribute } returns the instance of the RichEditorAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stopBackPress(isStopped: Optional): RichEditorAttribute; } @@ -4047,7 +4314,8 @@ declare class RichEditorAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CutEvent { /** @@ -4057,7 +4325,8 @@ declare interface CutEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preventDefault?: Callback; } @@ -4068,7 +4337,8 @@ declare interface CutEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CopyEvent { /** @@ -4078,7 +4348,8 @@ declare interface CopyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preventDefault?: Callback; } @@ -4089,7 +4360,8 @@ declare interface CopyEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RichEditorUrlStyle { /** @@ -4099,7 +4371,8 @@ declare interface RichEditorUrlStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ url?: ResourceStr; } @@ -4113,7 +4386,8 @@ declare interface RichEditorUrlStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type SubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => void; @@ -4126,7 +4400,8 @@ declare type SubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => vo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type MenuOnAppearCallback = (start: number, end: number) => void; @@ -4139,7 +4414,8 @@ declare type MenuOnAppearCallback = (start: number, end: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type MenuCallback = (start: number, end: number) => void; @@ -4151,7 +4427,8 @@ declare type MenuCallback = (start: number, end: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type PasteEventCallback = (event?: PasteEvent) => void; @@ -4164,7 +4441,8 @@ declare type PasteEventCallback = (event?: PasteEvent) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnHoverCallback = (status: boolean, event: HoverEvent) => void; @@ -4182,7 +4460,8 @@ declare type OnHoverCallback = (status: boolean, event: HoverEvent) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RichEditorInterface { /** @@ -4201,7 +4480,8 @@ interface RichEditorInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: RichEditorOptions): RichEditorAttribute; @@ -4213,7 +4493,8 @@ interface RichEditorInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (options: RichEditorStyledStringOptions): RichEditorAttribute; } diff --git a/api/@internal/component/ets/rich_text.d.ts b/api/@internal/component/ets/rich_text.d.ts index 043b0b8aac358a79354cb2db83be9cd2deea84ed..aa770b0556c842b04c064b8659ca398d521cfae4 100644 --- a/api/@internal/component/ets/rich_text.d.ts +++ b/api/@internal/component/ets/rich_text.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod} from './common'; +/*** endif */ + /** * Provides an interface for RichText component. * @@ -40,7 +44,8 @@ * @interface RichTextInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RichTextInterface { /** @@ -68,7 +73,8 @@ interface RichTextInterface { * @returns { RichTextAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (content: string): RichTextAttribute; } @@ -95,7 +101,8 @@ interface RichTextInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RichTextAttribute extends CommonMethod { /** @@ -123,7 +130,8 @@ declare class RichTextAttribute extends CommonMethod { * @returns { RichTextAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onStart(callback: () => void): RichTextAttribute; @@ -152,7 +160,8 @@ declare class RichTextAttribute extends CommonMethod { * @returns { RichTextAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onComplete(callback: () => void): RichTextAttribute; } diff --git a/api/@internal/component/ets/root_scene.d.ts b/api/@internal/component/ets/root_scene.d.ts index 503451a4751dd3ed000bce86b98819e43dfcc3aa..9d06f6b9740f03851dc23a96aeeacb6f7c7f6f80 100644 --- a/api/@internal/component/ets/root_scene.d.ts +++ b/api/@internal/component/ets/root_scene.d.ts @@ -17,14 +17,17 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { CommonMethod} from './common'; +/*** endif */ /** * Defines the session of RootScene. * * @interface RootSceneSession * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface RootSceneSession { } @@ -35,7 +38,8 @@ interface RootSceneSession { * @interface RootSceneInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface RootSceneInterface { /** @@ -45,7 +49,8 @@ interface RootSceneInterface { * @returns { RootSceneAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ (session: RootSceneSession): RootSceneAttribute; } @@ -56,7 +61,8 @@ interface RootSceneInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RootSceneAttribute extends CommonMethod { } diff --git a/api/@internal/component/ets/row.d.ts b/api/@internal/component/ets/row.d.ts index f05a61a938df25b773d0e32217033ccecd45cc2a..ee3b6bf646edd98265b79bffd913dc7ecc5e6e45 100644 --- a/api/@internal/component/ets/row.d.ts +++ b/api/@internal/component/ets/row.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { PointLightStyle, Optional, CommonMethod } from './common'; +import { VerticalAlign, FlexAlign } from './enums'; +import { SpaceType } from './column'; +/*** endif */ + + /** * Define options used to construct a row. * @@ -26,7 +33,8 @@ * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RowOptions { /** @@ -61,7 +69,8 @@ declare interface RowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ space?: string | number; } @@ -74,7 +83,8 @@ declare interface RowOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface RowOptionsV2 { /** @@ -85,7 +95,8 @@ interface RowOptionsV2 { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ space?: SpaceType; } @@ -122,7 +133,8 @@ interface RowOptionsV2 { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RowInterface { /** @@ -172,7 +184,8 @@ interface RowInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: RowOptions): RowAttribute; /** @@ -184,7 +197,8 @@ interface RowInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: RowOptions | RowOptionsV2): RowAttribute; } @@ -221,7 +235,8 @@ interface RowInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RowAttribute extends CommonMethod { /** @@ -260,7 +275,8 @@ declare class RowAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignItems(value: VerticalAlign): RowAttribute; @@ -300,7 +316,8 @@ declare class RowAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ justifyContent(value: FlexAlign): RowAttribute; /** @@ -310,7 +327,8 @@ declare class RowAttribute extends CommonMethod { * @returns { RowAttribute } The attribute of the row. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pointLight(value: PointLightStyle): RowAttribute; /** @@ -322,7 +340,8 @@ declare class RowAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reverse(isReversed: Optional): RowAttribute; } diff --git a/api/@internal/component/ets/row_split.d.ts b/api/@internal/component/ets/row_split.d.ts index 936f5c47b8492df8935a174740a702e895cd2a10..395b1e5e0a2cd92953b1690dff8175fbac7153f4 100644 --- a/api/@internal/component/ets/row_split.d.ts +++ b/api/@internal/component/ets/row_split.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +/*** endif */ + + /** * Provides interfaces for layout in the vertical direction. * @@ -40,7 +45,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RowSplitInterface { /** @@ -65,7 +71,8 @@ interface RowSplitInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): RowSplitAttribute; } @@ -86,7 +93,8 @@ interface RowSplitInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class RowSplitAttribute extends CommonMethod { /** @@ -114,7 +122,8 @@ declare class RowSplitAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ resizeable(value: boolean): RowSplitAttribute; } diff --git a/api/@internal/component/ets/save_button.d.ts b/api/@internal/component/ets/save_button.d.ts index ca52593e8e2faf3e09c7877938e26577d88326d4..0c370416cc8695aaa588f0f23b4d2037f2269484 100644 --- a/api/@internal/component/ets/save_button.d.ts +++ b/api/@internal/component/ets/save_button.d.ts @@ -18,20 +18,28 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ButtonType } from './button'; +import { ClickEvent } from './common'; +import { SecurityComponentMethod } from './securityComponent'; +import { BusinessError } from '../../@ohos.base' +/*** endif */ + /** * Enumerates the icon styles. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ /** * Enumerates the icon styles. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SaveIconStyle { /** @@ -45,7 +53,8 @@ declare enum SaveIconStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FULL_FILLED = 0, @@ -60,7 +69,8 @@ declare enum SaveIconStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LINES = 1, @@ -69,7 +79,8 @@ declare enum SaveIconStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PICTURE = 2 } @@ -77,17 +88,18 @@ declare enum SaveIconStyle { /** * Enumerates the text that can be displayed on the save button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ /** * Enumerates the text that can be displayed on the save button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SaveDescription { /** @@ -101,7 +113,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DOWNLOAD = 0, @@ -116,7 +129,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DOWNLOAD_FILE = 1, @@ -131,7 +145,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SAVE = 2, @@ -146,7 +161,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SAVE_IMAGE = 3, @@ -161,7 +177,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SAVE_FILE = 4, @@ -176,7 +193,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DOWNLOAD_AND_SHARE = 5, @@ -191,7 +209,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ RECEIVE = 6, @@ -206,7 +225,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUE_TO_RECEIVE = 7, @@ -215,7 +235,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SAVE_TO_GALLERY = 8, @@ -224,7 +245,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EXPORT_TO_GALLERY = 9, @@ -233,7 +255,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ QUICK_SAVE_TO_GALLERY = 10, @@ -242,7 +265,8 @@ declare enum SaveDescription { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RESAVE_TO_GALLERY = 11, @@ -269,7 +293,8 @@ declare enum SaveDescription { * @interface SaveButtonOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SaveButtonOptions { /** @@ -285,7 +310,8 @@ declare interface SaveButtonOptions { * @type { ?SaveIconStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ icon?: SaveIconStyle; @@ -302,7 +328,8 @@ declare interface SaveButtonOptions { * @type { ?SaveDescription } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ text?: SaveDescription; @@ -319,7 +346,8 @@ declare interface SaveButtonOptions { * @type { ?ButtonType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ buttonType?: ButtonType; } @@ -327,17 +355,18 @@ declare interface SaveButtonOptions { /** * Enumerates the click event results of the save button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 10 */ /** * Enumerates the click event results of the save button. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SaveButtonOnClickResult { /** @@ -351,7 +380,8 @@ declare enum SaveButtonOnClickResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SUCCESS = 0, @@ -366,7 +396,8 @@ declare enum SaveButtonOnClickResult { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ TEMPORARY_AUTHORIZATION_FAILED = 1 } @@ -384,7 +415,8 @@ declare enum SaveButtonOnClickResult { * @interface SaveButtonInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SaveButtonInterface { /** @@ -400,7 +432,8 @@ interface SaveButtonInterface { * @returns { SaveButtonAttribute } Returns the attribute of the save button. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ (): SaveButtonAttribute; @@ -421,11 +454,14 @@ interface SaveButtonInterface { * @returns { SaveButtonAttribute } Returns the attribute of the save button. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ (options: SaveButtonOptions): SaveButtonAttribute; } + + /** * Callback function when the save button is clicked. * @@ -435,7 +471,8 @@ interface SaveButtonInterface { * @param { BusinessError } [error] - The error code and message of click event. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ type SaveButtonCallback = (event: ClickEvent, result: SaveButtonOnClickResult, error?: BusinessError) => void; @@ -452,7 +489,8 @@ type SaveButtonCallback = (event: ClickEvent, result: SaveButtonOnClickResult, e * @extends SecurityComponentMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SaveButtonAttribute extends SecurityComponentMethod { /** @@ -479,7 +517,8 @@ declare class SaveButtonAttribute extends SecurityComponentMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScreenAttribute extends CommonMethod { } diff --git a/api/@internal/component/ets/scroll.d.ts b/api/@internal/component/ets/scroll.d.ts index 5b37398a442589a29281ff1bed4d9a9f25b075ef..42c71e62e25b459a77e5eeb986c7f05d2160b944 100644 --- a/api/@internal/component/ets/scroll.d.ts +++ b/api/@internal/component/ets/scroll.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { BarState, Edge, Color, EdgeEffect, ScrollSource ,Curve} from './enums' +import { ICurve, RectResult, ScrollableCommonMethod, EdgeEffectOptions, NestedScrollOptions,CommonMethod } from './common' +import { Dimension, Length, VoidCallback, Resource, LengthMetrics } from './units' +import { ScrollSnapAlign, ScrollState } from './list' +/*** endif */ + /** * Content scroll direction. * @@ -40,7 +47,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollDirection { /** @@ -62,7 +70,8 @@ declare enum ScrollDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Vertical, @@ -85,7 +94,8 @@ declare enum ScrollDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Horizontal, @@ -117,7 +127,8 @@ declare enum ScrollDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ None, } @@ -137,7 +148,8 @@ declare enum ScrollDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollAlign { /** @@ -153,7 +165,8 @@ declare enum ScrollAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START, @@ -170,7 +183,8 @@ declare enum ScrollAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER, @@ -187,7 +201,8 @@ declare enum ScrollAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END, @@ -204,7 +219,8 @@ declare enum ScrollAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO, } @@ -216,7 +232,8 @@ declare enum ScrollAlign { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OffsetResult { /** @@ -226,7 +243,8 @@ declare interface OffsetResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xOffset: number; @@ -237,7 +255,8 @@ declare interface OffsetResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ yOffset: number; } @@ -249,7 +268,8 @@ declare interface OffsetResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollEdgeOptions { /** @@ -259,7 +279,8 @@ declare interface ScrollEdgeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ velocity?: number; } @@ -271,7 +292,8 @@ declare interface ScrollEdgeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollToIndexOptions { /** @@ -281,7 +303,8 @@ declare interface ScrollToIndexOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ extraOffset?: LengthMetrics; } @@ -293,7 +316,8 @@ declare interface ScrollToIndexOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollAnimationOptions { /** @@ -303,7 +327,8 @@ declare interface ScrollAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; @@ -314,7 +339,8 @@ declare interface ScrollAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | ICurve; @@ -326,7 +352,8 @@ declare interface ScrollAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ canOverScroll?: boolean; } @@ -338,7 +365,8 @@ declare interface ScrollAnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OffsetOptions { /** @@ -348,7 +376,8 @@ declare interface OffsetOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ xOffset?: Dimension; @@ -359,7 +388,8 @@ declare interface OffsetOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ yOffset?: Dimension; } @@ -383,7 +413,8 @@ declare interface OffsetOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class Scroller { /** @@ -405,7 +436,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -444,6 +476,18 @@ declare class Scroller { */ scrollTo(options: ScrollOptions); + /** + * Called when the setting slides to the specified position. + * + * @param { ScrollOptions } options - scroll options + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scrollTo(options: ScrollOptions): void; + /** * Called when scrolling to the edge of the container. * @@ -480,6 +524,19 @@ declare class Scroller { */ scrollEdge(value: Edge, options?: ScrollEdgeOptions); + /** + * Called when scrolling to the edge of the container. + * + * @param { Edge } value - Edge type of the container. + * @param { ScrollEdgeOptions } [options] - Options of scrolling to edge. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scrollEdge(value: Edge, options?: ScrollEdgeOptions): void; + /** * Fling the scroll view. * @@ -492,7 +549,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fling(velocity: number): void; @@ -531,6 +589,18 @@ declare class Scroller { */ scrollPage(value: ScrollPageOptions); + /** + * Called when page turning mode is set. + * + * @param { ScrollPageOptions } value + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scrollPage(value: ScrollPageOptions): void; + /** * Called when page turning mode is set. * @@ -561,7 +631,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ currentOffset() : OffsetResult; @@ -609,6 +680,21 @@ declare class Scroller { */ scrollToIndex(value: number, smooth?: boolean, align?: ScrollAlign, options?: ScrollToIndexOptions); + /** + * Scroll to the specified index. + * + * @param { number } value - Index to jump to. + * @param { boolean } [smooth] - If true, scroll to index item with animation. If false, scroll to index item without animation. + * @param { ScrollAlign } [align] - Sets the alignment mode of a specified index. + * @param { ScrollToIndexOptions } [options] - Sets the options of a specified index, such as extra offset. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scrollToIndex(value: number, smooth?: boolean, align?: ScrollAlign, options?: ScrollToIndexOptions): void; + /** * Called when the setting slides by offset. * @@ -638,6 +724,19 @@ declare class Scroller { */ scrollBy(dx: Length, dy: Length); + /** + * Called when the setting slides by offset. + * + * @param { Length } dx + * @param { Length } dy + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + scrollBy(dx: Length, dy: Length): void; + /** * Indicates whether the component scrolls to the end position. * @@ -653,7 +752,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ isAtEnd(): boolean; @@ -684,7 +784,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getItemRect(index: number): RectResult; @@ -702,7 +803,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getItemIndex(x: number, y: number): number; } @@ -714,7 +816,8 @@ declare class Scroller { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollOptions { /** @@ -732,7 +835,8 @@ declare interface ScrollOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ xOffset: number | string; @@ -751,7 +855,8 @@ declare interface ScrollOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ yOffset: number | string; @@ -782,7 +887,8 @@ declare interface ScrollOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ animation?: ScrollAnimationOptions | boolean; } @@ -792,7 +898,8 @@ declare interface ScrollOptions { * @interface ScrollPageOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollPageOptions { /** @@ -802,7 +909,8 @@ declare interface ScrollPageOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ next: boolean; @@ -814,7 +922,8 @@ declare interface ScrollPageOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ animation?: boolean; } @@ -832,7 +941,8 @@ declare interface ScrollPageOptions { * @interface ScrollSnapOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollSnapOptions { /** @@ -848,7 +958,8 @@ declare interface ScrollSnapOptions { * @type { ScrollSnapAlign } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ snapAlign: ScrollSnapAlign; @@ -871,7 +982,8 @@ declare interface ScrollSnapOptions { * @default 100% * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ snapPagination?: Dimension | Array; @@ -890,7 +1002,8 @@ declare interface ScrollSnapOptions { * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableSnapToStart?: boolean; @@ -909,7 +1022,8 @@ declare interface ScrollSnapOptions { * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableSnapToEnd?: boolean; } @@ -936,7 +1050,8 @@ declare interface ScrollSnapOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScrollInterface { /** @@ -964,7 +1079,8 @@ interface ScrollInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (scroller?: Scroller): ScrollAttribute; } @@ -977,7 +1093,8 @@ interface ScrollInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnScrollEdgeCallback = (side: Edge) => void; @@ -988,7 +1105,8 @@ declare type OnScrollEdgeCallback = (side: Edge) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface OnScrollFrameBeginHandlerResult { /** @@ -1013,7 +1131,8 @@ interface OnScrollFrameBeginHandlerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offsetRemain: number; } @@ -1028,7 +1147,8 @@ interface OnScrollFrameBeginHandlerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnScrollFrameBeginCallback = (offset: number, state: ScrollState) => OnScrollFrameBeginHandlerResult; @@ -1054,7 +1174,8 @@ declare type OnScrollFrameBeginCallback = (offset: number, state: ScrollState) = * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScrollAttribute extends ScrollableCommonMethod { /** @@ -1082,7 +1203,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollable(value: ScrollDirection): ScrollAttribute; @@ -1126,7 +1248,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillScroll(handler: ScrollOnWillScrollCallback): ScrollAttribute; @@ -1139,7 +1262,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidScroll(handler: ScrollOnScrollCallback): ScrollAttribute; @@ -1178,7 +1302,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollEdge(event: OnScrollEdgeCallback): ScrollAttribute; @@ -1217,7 +1342,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStart(event: VoidCallback): ScrollAttribute; @@ -1268,7 +1394,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStop(event: VoidCallback): ScrollAttribute; @@ -1297,7 +1424,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBar(barState: BarState): ScrollAttribute; @@ -1326,7 +1454,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBarColor(color: Color | number | string): ScrollAttribute; @@ -1355,7 +1484,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollBarWidth(value: number | string): ScrollAttribute; @@ -1385,7 +1515,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ edgeEffect(edgeEffect: EdgeEffect, options?: EdgeEffectOptions): ScrollAttribute; @@ -1424,7 +1555,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollFrameBegin(event: OnScrollFrameBeginCallback): ScrollAttribute; @@ -1444,7 +1576,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ nestedScroll(value: NestedScrollOptions): ScrollAttribute; @@ -1465,7 +1598,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableScrollInteraction(value: boolean): ScrollAttribute; @@ -1486,7 +1620,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ friction(value: number | Resource): ScrollAttribute; @@ -1505,7 +1640,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @returns { ScrollAttribute } the attribute of the scroll. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollSnap(value: ScrollSnapOptions): ScrollAttribute; @@ -1526,7 +1662,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enablePaging(value: boolean): ScrollAttribute; @@ -1538,7 +1675,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ initialOffset(value: OffsetOptions): ScrollAttribute; } @@ -1553,7 +1691,8 @@ declare class ScrollAttribute extends ScrollableCommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ScrollOnScrollCallback = (xOffset: number, yOffset: number, scrollState: ScrollState) => void; @@ -1575,6 +1714,25 @@ declare type ScrollOnScrollCallback = (xOffset: number, yOffset: number, scrollS declare type ScrollOnWillScrollCallback = (xOffset: number, yOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => void | OffsetResult; + /** + * Called before scroll to allow developer to control real offset the Scroll can scroll. + * + * @typedef { function } ScrollOnWillScrollCallback + * @param { number } xOffset - horizontal offset this frame will scroll, which may or may not be reached. + * @param { number } yOffset - vertical offset this frame will scroll, which may or may not be reached. + * @param { ScrollState } scrollState - current scroll state. + * @param { ScrollSource } scrollSource - source of current scroll. + * @returns { undefined | OffsetResult } the remain offset for the Scroll, + * same as (xOffset, yOffset) when no OffsetResult is returned. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + declare type ScrollOnWillScrollCallback = + (xOffset: number, yOffset: number, scrollState: ScrollState, scrollSource: ScrollSource) => undefined | OffsetResult; + /** * Defines Scroll Component. * diff --git a/api/@internal/component/ets/scroll_bar.d.ts b/api/@internal/component/ets/scroll_bar.d.ts index e59281233ea707bea3b4a43ad32886a1f4def328..e67a7a80734d8c8187ffa6a77a30cd7c2027cad7 100644 --- a/api/@internal/component/ets/scroll_bar.d.ts +++ b/api/@internal/component/ets/scroll_bar.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Scroller } from './scroll' +import { BarState } from './enums' +import { Optional, CommonMethod } from './common' +/*** endif */ + /** * Content scroll direction. * @@ -40,7 +46,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ScrollBarDirection { /** @@ -62,7 +69,8 @@ declare enum ScrollBarDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Vertical, @@ -85,7 +93,8 @@ declare enum ScrollBarDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Horizontal, } @@ -112,7 +121,8 @@ declare enum ScrollBarDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScrollBarOptions { /** @@ -137,7 +147,8 @@ declare interface ScrollBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scroller: Scroller; @@ -163,7 +174,8 @@ declare interface ScrollBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: ScrollBarDirection; @@ -189,7 +201,8 @@ declare interface ScrollBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ state?: BarState; } @@ -216,7 +229,8 @@ declare interface ScrollBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScrollBarInterface { /** @@ -244,7 +258,8 @@ interface ScrollBarInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: ScrollBarOptions): ScrollBarAttribute; } @@ -271,7 +286,8 @@ interface ScrollBarInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScrollBarAttribute extends CommonMethod { /** @@ -281,7 +297,8 @@ declare class ScrollBarAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableNestedScroll(enabled: Optional): ScrollBarAttribute; } diff --git a/api/@internal/component/ets/search.d.ts b/api/@internal/component/ets/search.d.ts index 7a107792c52c6a02e72985e1d45ddb6dbfbe6141..42f355266bd6e4b998914466b0967de0d0c3c5d0 100644 --- a/api/@internal/component/ets/search.d.ts +++ b/api/@internal/component/ets/search.d.ts @@ -18,6 +18,18 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { TextContentControllerBase, SelectionOptions,Callback,CommonMethod,Optional,TextDecorationOptions, Bindable } from './common'; +import { CustomBuilder } from './builder'; +import { ResourceStr,Length,ResourceColor ,Dimension,Font} from './units'; +import { CaretStyle, EditableTextOnChangeCallback, InsertValue, DeleteValue, EditMenuOptions,KeyboardAppearance,EditableTextChangeValue,AutoCapitalizationMode } from './textCommon'; +import { EnterKeyType, OnTextSelectionChangeCallback, OnContentScrollCallback, OnPasteCallback, SubmitEvent } from './textInput'; +import { CopyOptions,TextAlign } from './enums'; +import { KeyboardOptions } from './richEditor'; +import { Resource } from '../../global/resource'; +import { SymbolGlyphModifier } from '../SymbolGlyphModifier'; +/*** endif */ + /** * Provides the method of switching the cursor position. * @@ -40,7 +52,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SearchController extends TextContentControllerBase { /** @@ -62,7 +75,8 @@ declare class SearchController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -88,7 +102,8 @@ declare class SearchController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ caretPosition(value: number): void; @@ -105,7 +120,8 @@ declare class SearchController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ stopEditing(): void; @@ -118,7 +134,8 @@ declare class SearchController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; } @@ -138,7 +155,8 @@ declare class SearchController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CancelButtonStyle { /** @@ -154,7 +172,8 @@ declare enum CancelButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONSTANT, @@ -171,7 +190,8 @@ declare enum CancelButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ INVISIBLE, @@ -188,7 +208,8 @@ declare enum CancelButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ INPUT } @@ -208,7 +229,8 @@ declare enum CancelButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SearchType { /** @@ -224,7 +246,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, @@ -241,7 +264,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER = 2, @@ -258,7 +282,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PHONE_NUMBER = 3, @@ -275,7 +300,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EMAIL = 5, @@ -285,7 +311,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER_DECIMAL = 12, @@ -295,7 +322,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ URL = 13, } @@ -307,7 +335,8 @@ declare enum SearchType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SearchOptions { /** @@ -327,6 +356,17 @@ declare interface SearchOptions { */ value?: string; + /** + * Text input in the search text box. + * + * @type { ?(string | Bindable)} + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + value?: string | Bindable; + /** * Text displayed when there is no input. * @@ -347,7 +387,8 @@ declare interface SearchOptions { * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ placeholder?: ResourceStr; @@ -364,7 +405,8 @@ declare interface SearchOptions { * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ icon?: string; @@ -381,7 +423,8 @@ declare interface SearchOptions { * @type { ?SearchController } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ controller?: SearchController; } @@ -408,7 +451,8 @@ declare interface SearchOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SearchInterface { /** @@ -446,7 +490,8 @@ interface SearchInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ (options?: SearchOptions): SearchAttribute; } @@ -466,7 +511,8 @@ interface SearchInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface IconOptions { /** @@ -484,7 +530,8 @@ interface IconOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ size?: Length; @@ -503,7 +550,8 @@ interface IconOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -522,7 +570,8 @@ interface IconOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ src?: ResourceStr; } @@ -542,7 +591,8 @@ interface IconOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SearchButtonOptions { /** @@ -560,7 +610,8 @@ interface SearchButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: Length; @@ -579,7 +630,8 @@ interface SearchButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; @@ -590,7 +642,8 @@ interface SearchButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ autoDisable?: Boolean; } @@ -602,7 +655,8 @@ interface SearchButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CancelButtonOptions { /** @@ -612,7 +666,8 @@ interface CancelButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ style?: CancelButtonStyle; @@ -623,7 +678,8 @@ interface CancelButtonOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ icon?: IconOptions; } @@ -634,7 +690,8 @@ interface CancelButtonOptions { * @interface CancelButtonSymbolOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CancelButtonSymbolOptions { /** @@ -643,7 +700,8 @@ interface CancelButtonSymbolOptions { * @type { ?CancelButtonStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ style?: CancelButtonStyle; @@ -653,7 +711,8 @@ interface CancelButtonSymbolOptions { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ icon?: SymbolGlyphModifier; } @@ -667,7 +726,8 @@ interface CancelButtonSymbolOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare type SearchSubmitCallback = (searchContent: string, event?: SubmitEvent) => void; @@ -693,7 +753,8 @@ declare type SearchSubmitCallback = (searchContent: string, event?: SubmitEvent) * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SearchAttribute extends CommonMethod { /** @@ -724,7 +785,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ searchButton(value: string, option?: SearchButtonOptions): SearchAttribute; @@ -745,7 +807,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): SearchAttribute; @@ -776,7 +839,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ searchIcon(value: IconOptions | SymbolGlyphModifier): SearchAttribute; @@ -807,7 +871,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ cancelButton(value: CancelButtonOptions | CancelButtonSymbolOptions): SearchAttribute; @@ -819,7 +884,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ textIndent(value: Dimension): SearchAttribute; @@ -832,7 +898,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ inputFilter(value: ResourceStr, error?: Callback): SearchAttribute; @@ -844,7 +911,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onEditChange(callback: Callback): SearchAttribute; @@ -856,7 +924,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ selectedBackgroundColor(value: ResourceColor): SearchAttribute; @@ -877,7 +946,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ caretStyle(value: CaretStyle): SearchAttribute; @@ -906,7 +976,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ placeholderColor(value: ResourceColor): SearchAttribute; @@ -935,7 +1006,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ placeholderFont(value?: Font): SearchAttribute; @@ -964,7 +1036,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textFont(value?: Font): SearchAttribute; @@ -976,7 +1049,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType(value: EnterKeyType): SearchAttribute; @@ -1030,6 +1104,19 @@ declare class SearchAttribute extends CommonMethod { */ onSubmit(callback: SearchSubmitCallback): SearchAttribute; + /** + * Call the function when clicked the search button. + * + * @param { Callback | SearchSubmitCallback } callback - callback of the listened event. + * @returns { SearchAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onSubmit(callback: Callback | SearchSubmitCallback): SearchAttribute; + /** * Call the function when editing the input text * @@ -1065,7 +1152,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: EditableTextOnChangeCallback): SearchAttribute; @@ -1096,7 +1184,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onTextSelectionChange(callback: OnTextSelectionChangeCallback): SearchAttribute; @@ -1127,7 +1216,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onContentScroll(callback: OnContentScrollCallback): SearchAttribute; @@ -1166,7 +1256,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onCopy(callback: Callback): SearchAttribute; @@ -1205,7 +1296,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onCut(callback: Callback): SearchAttribute; @@ -1247,7 +1339,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onPaste(callback: OnPasteCallback): SearchAttribute; @@ -1276,7 +1369,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ copyOption(value: CopyOptions): SearchAttribute; @@ -1297,7 +1391,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maxLength(value: number): SearchAttribute; @@ -1326,7 +1421,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textAlign(value: TextAlign): SearchAttribute; @@ -1347,7 +1443,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enableKeyboardOnFocus(value: boolean): SearchAttribute; @@ -1368,7 +1465,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ selectionMenuHidden(value: boolean): SearchAttribute; @@ -1380,7 +1478,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize(value: number | string | Resource): SearchAttribute; @@ -1392,7 +1491,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontSize(value: number | string | Resource): SearchAttribute; @@ -1403,7 +1503,8 @@ declare class SearchAttribute extends CommonMethod { * @returns { SearchAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: Optional): SearchAttribute; @@ -1414,7 +1515,8 @@ declare class SearchAttribute extends CommonMethod { * @returns { SearchAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: Optional): SearchAttribute; @@ -1445,7 +1547,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ customKeyboard(value: CustomBuilder, options?: KeyboardOptions): SearchAttribute; @@ -1457,7 +1560,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ decoration(value: TextDecorationOptions): SearchAttribute; @@ -1469,7 +1573,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing(value: number | string | Resource): SearchAttribute; @@ -1481,7 +1586,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight(value: number | string | Resource): SearchAttribute; @@ -1502,7 +1608,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type(value: SearchType): SearchAttribute; @@ -1518,7 +1625,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature(value: string): SearchAttribute; @@ -1530,7 +1638,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onWillInsert(callback: Callback): SearchAttribute; @@ -1542,7 +1651,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onDidInsert(callback: Callback): SearchAttribute; @@ -1554,7 +1664,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onWillDelete(callback: Callback): SearchAttribute; @@ -1566,7 +1677,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onDidDelete(callback: Callback): SearchAttribute; @@ -1578,7 +1690,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ editMenuOptions(editMenu: EditMenuOptions): SearchAttribute; @@ -1590,7 +1703,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enablePreviewText(enable: boolean): SearchAttribute; @@ -1602,7 +1716,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(isEnabled: boolean): SearchAttribute; @@ -1614,7 +1729,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20', '1.2':'20'} + * @arkts 1.1&1.2 */ autoCapitalizationMode(mode: AutoCapitalizationMode): SearchAttribute; @@ -1626,7 +1742,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading(halfLeading: Optional): SearchAttribute; @@ -1637,7 +1754,8 @@ declare class SearchAttribute extends CommonMethod { * @returns { SearchAttribute } returns the instance of the SearchAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ stopBackPress(isStopped: Optional): SearchAttribute; @@ -1649,7 +1767,8 @@ declare class SearchAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ onWillChange(callback: Callback): SearchAttribute; @@ -1660,7 +1779,8 @@ declare class SearchAttribute extends CommonMethod { * @returns { SearchAttribute } returns the instance of the SearchAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAppearance(appearance: Optional): SearchAttribute; } diff --git a/api/@internal/component/ets/security_component.d.ts b/api/@internal/component/ets/security_component.d.ts index fb81d711dcafe070c57a06223d4c599c2831af0e..59fcccef62a01df5177f2b2dde8d1d06166b4ba0 100644 --- a/api/@internal/component/ets/security_component.d.ts +++ b/api/@internal/component/ets/security_component.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Dimension, Position, Edges, LocalizedEdges, ResourceColor, Padding, Length, SizeOptions, ConstraintSizeOptions, BorderRadiuses } from './units'; +import { FontStyle, FontWeight, BorderStyle, TextHeightAdaptivePolicy, Axis, Alignment } from './enums'; +import { ChainStyle, LocalizedAlignRuleOptions, AlignRuleOption } from './common'; +import { Resource } from '../../global/resource'; +/*** endif */ + /** * Enumerates the layout direction of the icon and text. * @@ -65,6 +72,37 @@ declare enum SecurityComponentLayoutDirection { VERTICAL = 1 } +/** + * Enumerates the layout direction of the icon and text. + * + * @enum { int } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare enum SecurityComponentLayoutDirection { + /** + * Horizontal layout. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + HORIZONTAL = 0, + + /** + * Vertical layout. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + VERTICAL = 1 +} + /** * Defines the method of a security component. * @@ -76,7 +114,8 @@ declare enum SecurityComponentLayoutDirection { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SecurityComponentMethod { /** @@ -94,7 +133,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ iconSize(value: Dimension): T; @@ -113,7 +153,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ layoutDirection(value: SecurityComponentLayoutDirection): T; @@ -132,7 +173,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ position(value: Position): T; @@ -153,7 +195,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ markAnchor(value: Position): T; @@ -187,7 +230,8 @@ declare class SecurityComponentMethod { * @returns { T } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ offset(value: Position | Edges | LocalizedEdges): T; @@ -206,7 +250,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Dimension): T; @@ -225,7 +270,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): T; @@ -248,6 +294,18 @@ declare class SecurityComponentMethod { */ fontWeight(value: number | FontWeight | string): T; + /** + * Font weight of the inner text. + * + * @param { int | FontWeight | string } value - Indicates the font weight of the text in the security component. + * @returns { T } Returns the attribute of the security component. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + fontWeight(value: int | FontWeight | string): T; + /** * Font family of the inner text. * @@ -263,7 +321,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: string | Resource): T; @@ -282,7 +341,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): T; @@ -301,7 +361,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ iconColor(value: ResourceColor): T; @@ -320,7 +381,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor(value: ResourceColor): T; @@ -339,7 +401,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ borderStyle(value: BorderStyle): T; @@ -358,7 +421,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ borderWidth(value: Dimension): T; @@ -377,7 +441,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ borderColor(value: ResourceColor): T; @@ -396,7 +461,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius(value: Dimension): T; @@ -426,7 +492,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ padding(value: Padding | Dimension): T; @@ -445,7 +512,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textIconSpace(value: Dimension): T; @@ -456,7 +524,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 * @test */ key(value: string): T; @@ -476,7 +545,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ width(value: Length): T; @@ -495,7 +565,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ height(value: Length): T; @@ -514,7 +585,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ size(value: SizeOptions): T; @@ -535,7 +607,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constraintSize(value: ConstraintSizeOptions): T; @@ -546,7 +619,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ align(alignType: Alignment): T; @@ -557,7 +631,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ alignRules(alignRule: AlignRuleOption): T; @@ -568,7 +643,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ alignRules(alignRule: LocalizedAlignRuleOptions): T; @@ -579,7 +655,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ id(description: string): T; @@ -591,7 +668,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ chainMode(direction: Axis, style: ChainStyle): T; @@ -602,7 +680,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attributes of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: number | Resource): T; @@ -613,7 +692,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attributes of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: number | Resource): T; @@ -624,7 +704,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxLines(line: number): T; @@ -635,7 +716,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize(minSize: number | string | Resource): T; @@ -646,7 +728,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontSize(maxSize: number | string | Resource): T; @@ -657,7 +740,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ heightAdaptivePolicy(policy: TextHeightAdaptivePolicy): T; @@ -669,7 +753,8 @@ declare class SecurityComponentMethod { * @returns { T } Returns the attribute of the security component. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ enabled(respond: boolean): T; } diff --git a/api/@internal/component/ets/select.d.ts b/api/@internal/component/ets/select.d.ts index 6a7584ccda3530f6c48bb3ef631578bccf438bb2..741b2d27b2f7ed94eec18ebc6c1bd81f8003dcf0 100644 --- a/api/@internal/component/ets/select.d.ts +++ b/api/@internal/component/ets/select.d.ts @@ -18,6 +18,16 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonConfiguration, CommonMethod, ContentModifier, Optional, BlurStyle, Bindable } from './common'; +import { ControlSize } from './button'; +import { DividerOptions } from './textPicker'; +import { ResourceStr, Dimension, EdgeOutlineWidths, ResourceColor, EdgeColors, Resource, Font, Length, Offset, DividerStyleOptions } from './units'; +import { SymbolGlyphModifier } from '../SymbolGlyphModifier'; +import { TextModifier } from '../TextModifier'; +import { OptionWidthMode } from './enums'; +/*** endif */ + /** * The declare of selectOption. * @@ -40,7 +50,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SelectOption { /** @@ -65,7 +76,8 @@ declare interface SelectOption { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: ResourceStr; @@ -91,7 +103,8 @@ declare interface SelectOption { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: ResourceStr; @@ -101,7 +114,8 @@ declare interface SelectOption { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolIcon?: SymbolGlyphModifier; } @@ -128,7 +142,8 @@ declare interface SelectOption { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SelectInterface { /** @@ -156,7 +171,8 @@ interface SelectInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options: Array): SelectAttribute; } @@ -176,7 +192,8 @@ interface SelectInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ArrowPosition { /** @@ -192,7 +209,8 @@ declare enum ArrowPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END = 0, @@ -209,7 +227,8 @@ declare enum ArrowPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START = 1 } @@ -228,7 +247,8 @@ declare enum ArrowPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MenuAlignType { /** @@ -243,7 +263,8 @@ declare enum MenuAlignType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ START, /** @@ -258,7 +279,8 @@ declare enum MenuAlignType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER, /** @@ -273,7 +295,8 @@ declare enum MenuAlignType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ END } @@ -284,7 +307,8 @@ declare enum MenuAlignType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AvoidanceMode { /** @@ -293,7 +317,8 @@ declare enum AvoidanceMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ COVER_TARGET, /** @@ -302,7 +327,8 @@ declare enum AvoidanceMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ AVOID_AROUND_TARGET } @@ -316,7 +342,8 @@ declare enum AvoidanceMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnSelectCallback = (index: number, selectStr: string) => void; @@ -327,7 +354,8 @@ declare type OnSelectCallback = (index: number, selectStr: string) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MenuOutlineOptions { /** @@ -337,7 +365,8 @@ declare interface MenuOutlineOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Dimension | EdgeOutlineWidths; @@ -348,7 +377,8 @@ declare interface MenuOutlineOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor | EdgeColors; } @@ -375,7 +405,8 @@ declare interface MenuOutlineOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SelectAttribute extends CommonMethod { /** @@ -419,6 +450,20 @@ declare class SelectAttribute extends CommonMethod { */ selected(numCount: Optional): SelectAttribute; + /** + * Sets the serial number of the select item, starting from 0. + * + * @param { number | Resource | undefined | Bindable } numCount - the serial number of the select item. + * @returns { SelectAttribute } the attribute of the select. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + selected(numCount: number | Resource | undefined | Bindable): SelectAttribute; + + /** * Sets the text display of the select button itself. * @@ -460,6 +505,19 @@ declare class SelectAttribute extends CommonMethod { */ value(resStr: Optional): SelectAttribute; + /** + * Sets the text display of the select button itself. + * + * @param { ResourceStr | undefined | Bindable } resStr - the text display of the select button itself. + * @returns { SelectAttribute } the attribute of the select. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + value(resStr: ResourceStr | undefined | Bindable): SelectAttribute; + /** * Sets the text properties of the select button itself. * @@ -485,7 +543,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ font(value: Font): SelectAttribute; @@ -497,7 +556,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ font(selectFont: Optional): SelectAttribute; @@ -526,7 +586,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): SelectAttribute; @@ -538,7 +599,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(resColor: Optional): SelectAttribute; @@ -567,7 +629,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionBgColor(value: ResourceColor): SelectAttribute; @@ -579,7 +642,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionBgColor(resColor: Optional): SelectAttribute; @@ -608,7 +672,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionFont(value: Font): SelectAttribute; @@ -620,7 +685,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionFont(selectFont: Optional): SelectAttribute; @@ -649,7 +715,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionFontColor(value: ResourceColor): SelectAttribute; @@ -661,7 +728,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionFontColor(resColor: Optional): SelectAttribute; @@ -690,7 +758,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ optionBgColor(value: ResourceColor): SelectAttribute; @@ -702,7 +771,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ optionBgColor(resColor: Optional): SelectAttribute; @@ -731,7 +801,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ optionFont(value: Font): SelectAttribute; @@ -743,7 +814,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ optionFont(selectFont: Optional): SelectAttribute; @@ -772,7 +844,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ optionFontColor(value: ResourceColor): SelectAttribute; @@ -784,7 +857,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ optionFontColor(resColor: Optional): SelectAttribute; @@ -825,7 +899,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onSelect(callback: Optional): SelectAttribute; @@ -846,7 +921,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ space(value: Length): SelectAttribute; @@ -858,7 +934,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ space(spaceLength: Optional): SelectAttribute; @@ -879,7 +956,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrowPosition(value: ArrowPosition): SelectAttribute; @@ -891,7 +969,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowPosition(position: Optional): SelectAttribute; @@ -913,7 +992,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ menuAlign(alignType: MenuAlignType, offset?: Offset): SelectAttribute; @@ -926,7 +1006,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ menuAlign(alignType: Optional, offset?: Offset): SelectAttribute; @@ -947,7 +1028,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ optionWidth(value: Dimension | OptionWidthMode ): SelectAttribute; @@ -959,7 +1041,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ optionWidth(width: Optional ): SelectAttribute; @@ -980,7 +1063,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ optionHeight(value: Dimension): SelectAttribute; @@ -992,7 +1076,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ optionHeight(height: Optional): SelectAttribute; @@ -1013,7 +1098,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ menuBackgroundColor(value: ResourceColor): SelectAttribute; @@ -1025,7 +1111,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ menuBackgroundColor(resColor: Optional): SelectAttribute; @@ -1046,7 +1133,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ menuBackgroundBlurStyle(value: BlurStyle): SelectAttribute; @@ -1058,7 +1146,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ menuBackgroundBlurStyle(style: Optional): SelectAttribute; @@ -1070,7 +1159,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ controlSize(value: ControlSize): SelectAttribute; @@ -1082,7 +1172,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ controlSize(size: Optional): SelectAttribute; @@ -1094,7 +1185,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ menuItemContentModifier(modifier: ContentModifier): SelectAttribute; @@ -1106,7 +1198,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ menuItemContentModifier(modifier: Optional>): SelectAttribute; @@ -1118,7 +1211,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ divider(options: Optional | null): SelectAttribute; @@ -1130,7 +1224,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ textModifier(modifier: Optional): SelectAttribute; @@ -1142,7 +1237,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ arrowModifier(modifier: Optional): SelectAttribute; @@ -1154,7 +1250,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ optionTextModifier(modifier: Optional): SelectAttribute; @@ -1166,7 +1263,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedOptionTextModifier(modifier: Optional): SelectAttribute; @@ -1178,7 +1276,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ dividerStyle(style: Optional): SelectAttribute; @@ -1190,7 +1289,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ avoidance(mode: AvoidanceMode): SelectAttribute; @@ -1202,7 +1302,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ menuOutline(outline: MenuOutlineOptions): SelectAttribute; } @@ -1215,7 +1316,8 @@ declare class SelectAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MenuItemConfiguration extends CommonConfiguration{ /** @@ -1225,7 +1327,8 @@ declare interface MenuItemConfiguration extends CommonConfiguration { /** @@ -372,7 +385,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ viewPort(value: ViewportRect): ShapeAttribute; @@ -412,7 +426,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stroke(value: ResourceColor): ShapeAttribute; @@ -452,7 +467,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fill(value: ResourceColor): ShapeAttribute; @@ -492,7 +508,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeDashOffset(value: number | string): ShapeAttribute; @@ -536,6 +553,20 @@ declare class ShapeAttribute extends CommonMethod { */ strokeDashArray(value: Array): ShapeAttribute; + /** + * Called when the gap of the border is set. + * + * @param { Array } value + * @returns { ShapeAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + strokeDashArray(value: Array): ShapeAttribute; + /** * Called when the path endpoint drawing style is set. * @@ -572,7 +603,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeLineCap(value: LineCapStyle): ShapeAttribute; @@ -612,7 +644,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeLineJoin(value: LineJoinStyle): ShapeAttribute; @@ -652,7 +685,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeMiterLimit(value: number | string): ShapeAttribute; @@ -692,7 +726,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeOpacity(value: number | string | Resource): ShapeAttribute; @@ -732,7 +767,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fillOpacity(value: number | string | Resource): ShapeAttribute; @@ -772,7 +808,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth(value: number | string): ShapeAttribute; @@ -812,7 +849,8 @@ declare class ShapeAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ antiAlias(value: boolean): ShapeAttribute; @@ -863,6 +901,22 @@ declare class ShapeAttribute extends CommonMethod { * @since 11 */ mesh(value: Array, column: number, row: number): ShapeAttribute; + + /** + * Called when shape mesh. + * + * @param { Array } value + * @param { number } column + * @param { number } row + * @returns { ShapeAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + mesh(value: Array, column: number, row: number): ShapeAttribute; } /** @@ -928,3 +982,29 @@ declare const Shape: ShapeInterface; * @since 11 */ declare const ShapeInstance: ShapeAttribute; + +/** + * Provides interfaces for drawing components. + * + * @interface ShapeInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface ShapeInterface { + /** + * Shape component constructor. + * + * @param { PixelMap } [value] - PixelMap object to draw. + * @returns { ShapeAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (value?: PixelMap): ShapeAttribute; +} diff --git a/api/@internal/component/ets/sidebar.d.ts b/api/@internal/component/ets/sidebar.d.ts index 2890bf36f0f17dd5764c307f4496f488aa80eca4..cbb6b4f087e80fb19136d4edd08465e59d2342b7 100644 --- a/api/@internal/component/ets/sidebar.d.ts +++ b/api/@internal/component/ets/sidebar.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource' +import { Length, ResourceColor, Dimension } from './units' +import { CommonMethod, PixelMap, Bindable } from './common' +/*** endif */ + /** * Sets the sidebar style of showing * @@ -40,7 +46,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SideBarContainerType { /** @@ -62,7 +69,8 @@ declare enum SideBarContainerType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Embed, @@ -85,7 +93,8 @@ declare enum SideBarContainerType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Overlay, @@ -100,7 +109,8 @@ declare enum SideBarContainerType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO, } @@ -127,7 +137,8 @@ declare enum SideBarContainerType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SideBarPosition { /** @@ -149,7 +160,8 @@ declare enum SideBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -172,7 +184,8 @@ declare enum SideBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, } @@ -184,7 +197,8 @@ declare enum SideBarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ButtonIconOptions { /** @@ -211,6 +225,17 @@ declare interface ButtonIconOptions { * @atomicservice * @since 11 */ + /** + * Defines whether an icon is shown. + * + * Anonymous Object Rectification. + * @type { string | PixelMap | Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ shown: string | PixelMap | Resource; /** @@ -237,6 +262,17 @@ declare interface ButtonIconOptions { * @atomicservice * @since 11 */ + /** + * Defines whether an icon is hidden. + * + * Anonymous Object Rectification. + * @type { string | PixelMap | Resource } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ hidden: string | PixelMap | Resource; /** @@ -263,6 +299,17 @@ declare interface ButtonIconOptions { * @atomicservice * @since 11 */ + /** + * Defines whether an icon is switching. + * + * Anonymous Object Rectification. + * @type { ?(string | PixelMap | Resource) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ switching?: string | PixelMap | Resource; } @@ -288,7 +335,8 @@ declare interface ButtonIconOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ButtonStyle { /** @@ -316,7 +364,8 @@ declare interface ButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: number; @@ -345,7 +394,8 @@ declare interface ButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: number; @@ -374,7 +424,8 @@ declare interface ButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: number; @@ -403,7 +454,8 @@ declare interface ButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number; @@ -438,7 +490,8 @@ declare interface ButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ icons?: ButtonIconOptions; } @@ -465,7 +518,8 @@ declare interface ButtonStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SideBarContainerInterface { /** @@ -493,7 +547,8 @@ interface SideBarContainerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (type?: SideBarContainerType): SideBarContainerAttribute; } @@ -515,7 +570,8 @@ interface SideBarContainerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface DividerStyle { /** @@ -535,7 +591,8 @@ interface DividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth: Length; @@ -554,7 +611,8 @@ interface DividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -573,7 +631,8 @@ interface DividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startMargin?: Length; @@ -592,7 +651,8 @@ interface DividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endMargin?: Length; } @@ -619,7 +679,8 @@ interface DividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SideBarContainerAttribute extends CommonMethod { /** @@ -651,6 +712,19 @@ declare class SideBarContainerAttribute extends CommonMethod } value + * @returns { SideBarContainerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + showSideBar(value: boolean | Bindable): SideBarContainerAttribute; + /** * Callback controlButton function when setting the style of button * @@ -676,7 +750,8 @@ declare class SideBarContainerAttribute extends CommonMethod void): SideBarContainerAttribute; @@ -770,6 +847,20 @@ declare class SideBarContainerAttribute extends CommonMethod } value + * @returns { SideBarContainerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + sideBarWidth(value: number | Bindable): SideBarContainerAttribute; + /** * Sets the min length of sidebar. * default value is 200vp. @@ -798,7 +889,8 @@ declare class SideBarContainerAttribute extends CommonMethod) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + value?: number | undefined | Bindable; + /** * Sets the min value of Slider. * @@ -469,7 +511,8 @@ declare interface SliderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ min?: number; @@ -505,7 +548,8 @@ declare interface SliderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ max?: number; @@ -541,7 +585,8 @@ declare interface SliderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ step?: number; @@ -577,7 +622,8 @@ declare interface SliderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: SliderStyle; @@ -613,7 +659,8 @@ declare interface SliderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction?: Axis; @@ -649,7 +696,8 @@ declare interface SliderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reverse?: boolean; } @@ -669,7 +717,8 @@ declare interface SliderOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SliderBlockType { /** @@ -685,7 +734,8 @@ declare enum SliderBlockType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT, @@ -702,7 +752,8 @@ declare enum SliderBlockType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE, @@ -719,7 +770,8 @@ declare enum SliderBlockType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SHAPE, } @@ -739,7 +791,8 @@ declare enum SliderBlockType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SliderBlockStyle { /** @@ -757,7 +810,8 @@ declare interface SliderBlockStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: SliderBlockType; @@ -776,7 +830,8 @@ declare interface SliderBlockStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ image?: ResourceStr; @@ -795,7 +850,8 @@ declare interface SliderBlockStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ shape?: CircleAttribute | EllipseAttribute | PathAttribute | RectAttribute; } @@ -809,7 +865,8 @@ declare interface SliderBlockStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMode) => void; @@ -821,7 +878,8 @@ declare type SliderTriggerChangeCallback = (value: number, mode: SliderChangeMod * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SliderConfiguration extends CommonConfiguration { /** @@ -831,7 +889,8 @@ declare interface SliderConfiguration extends CommonConfiguration { /** @@ -1027,7 +1093,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blockColor(value: ResourceColor): SliderAttribute; @@ -1078,7 +1145,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ trackColor(value: ResourceColor | LinearGradient): SliderAttribute; @@ -1118,7 +1186,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(value: ResourceColor): SliderAttribute; /** @@ -1130,7 +1199,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(selectedColor: ResourceColor | LinearGradient): SliderAttribute; @@ -1194,7 +1264,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showSteps(value: boolean): SliderAttribute; @@ -1238,7 +1309,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showTips(value: boolean, content?: ResourceStr): SliderAttribute; @@ -1278,7 +1350,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ trackThickness(value: Length): SliderAttribute; @@ -1318,7 +1391,8 @@ declare class SliderAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: (value: number, mode: SliderChangeMode) => void): SliderAttribute; @@ -1339,7 +1413,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blockBorderColor(value: ResourceColor): SliderAttribute; @@ -1360,7 +1435,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blockBorderWidth(value: Length): SliderAttribute; @@ -1381,7 +1457,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stepColor(value: ResourceColor): SliderAttribute; @@ -1402,7 +1479,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ trackBorderRadius(value: Length): SliderAttribute; @@ -1414,7 +1492,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectedBorderRadius(value: Dimension): SliderAttribute; @@ -1435,7 +1514,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blockSize(value: SizeOptions): SliderAttribute; @@ -1456,7 +1536,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blockStyle(value: SliderBlockStyle): SliderAttribute; @@ -1477,7 +1558,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stepSize(value: Length): SliderAttribute; @@ -1489,7 +1571,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sliderInteractionMode(value: SliderInteraction): SliderAttribute; @@ -1501,7 +1584,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ minResponsiveDistance(value: number): SliderAttribute; @@ -1513,7 +1597,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): SliderAttribute; @@ -1525,7 +1610,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ slideRange(value: SlideRange): SliderAttribute; @@ -1537,7 +1623,8 @@ declare class SliderAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ digitalCrownSensitivity(sensitivity: Optional): SliderAttribute; @@ -1548,7 +1635,8 @@ declare class SliderAttribute extends CommonMethod { * @returns { SliderAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(enabled: boolean): SliderAttribute; } diff --git a/api/@internal/component/ets/span.d.ts b/api/@internal/component/ets/span.d.ts index ece02031b8510b30e5203ce525858629a1480fb1..274a48935b04df9ffcc16235fb1fac277641a635 100644 --- a/api/@internal/component/ets/span.d.ts +++ b/api/@internal/component/ets/span.d.ts @@ -18,6 +18,15 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor, Dimension, BorderRadiuses, Length, Font } from './units'; +import { CommonMethod, ShadowOptions } from './common'; +import { LengthMetrics } from './../Graphics'; +import { Resource } from './../../../api/global/resource'; +import { FontStyle, FontWeight, TextCase } from './enums'; +import { DecorationStyleInterface } from './styledString'; +/*** endif */ + /** * Define the background style of span. * @@ -33,7 +42,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextBackgroundStyle { /** @@ -51,7 +61,8 @@ declare interface TextBackgroundStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -70,7 +81,8 @@ declare interface TextBackgroundStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: Dimension | BorderRadiuses; } @@ -90,7 +102,8 @@ declare interface TextBackgroundStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class BaseSpan extends CommonMethod { /** @@ -110,7 +123,8 @@ declare class BaseSpan extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textBackgroundStyle(style: TextBackgroundStyle): T; @@ -122,7 +136,8 @@ declare class BaseSpan extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ baselineOffset(value: LengthMetrics): T; } @@ -159,7 +174,8 @@ declare class BaseSpan extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SpanInterface { /** @@ -198,7 +214,8 @@ interface SpanInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: string | Resource): SpanAttribute; } @@ -227,7 +244,8 @@ interface SpanInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SpanAttribute extends BaseSpan { /** @@ -246,7 +264,8 @@ declare class SpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ font(value: Font): SpanAttribute; @@ -286,7 +305,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): SpanAttribute; @@ -326,7 +346,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: number | string | Resource): SpanAttribute; @@ -366,7 +387,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): SpanAttribute; @@ -406,7 +428,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): SpanAttribute; @@ -446,7 +469,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: string | Resource): SpanAttribute; @@ -497,7 +521,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration(value: DecorationStyleInterface): SpanAttribute; @@ -537,7 +562,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing(value: number | string): SpanAttribute; @@ -577,7 +603,8 @@ declare class SpanAttribute extends BaseSpan { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textCase(value: TextCase): SpanAttribute; @@ -597,7 +624,8 @@ declare class SpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight(value: Length): SpanAttribute; @@ -618,7 +646,8 @@ declare class SpanAttribute extends BaseSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textShadow(value: ShadowOptions | Array): SpanAttribute; } diff --git a/api/@internal/component/ets/stack.d.ts b/api/@internal/component/ets/stack.d.ts index a69c515b8e81f3a6b5580204f6350806ebfe95a6..cc542a44c30c51a8eda22faf279c2b369549e7b9 100644 --- a/api/@internal/component/ets/stack.d.ts +++ b/api/@internal/component/ets/stack.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { PointLightStyle, CommonMethod } from './common'; +import { Alignment } from './enums'; +/*** endif */ + /** * Options used to construct the stack. * @@ -26,7 +31,8 @@ * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface StackOptions { /** @@ -61,7 +67,8 @@ declare interface StackOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignContent?: Alignment; } @@ -98,7 +105,8 @@ declare interface StackOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface StackInterface { /** @@ -148,7 +156,8 @@ interface StackInterface { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: StackOptions): StackAttribute; } @@ -177,7 +186,8 @@ interface StackInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class StackAttribute extends CommonMethod { /** @@ -216,7 +226,8 @@ declare class StackAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignContent(value: Alignment): StackAttribute; @@ -227,7 +238,8 @@ declare class StackAttribute extends CommonMethod { * @returns { StackAttribute } The attribute of the stack. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pointLight(value: PointLightStyle): StackAttribute; } diff --git a/api/@internal/component/ets/state_management.d.ts b/api/@internal/component/ets/state_management.d.ts index 7db8947e5c83e95aa17f2f194bea6131ba88fd2b..228a3429a362c849a43196efbbac150580a71060 100644 --- a/api/@internal/component/ets/state_management.d.ts +++ b/api/@internal/component/ets/state_management.d.ts @@ -31,7 +31,8 @@ * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ColorMode { /** @@ -45,7 +46,8 @@ declare enum ColorMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHT = 0, @@ -60,7 +62,8 @@ declare enum ColorMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DARK, } @@ -78,7 +81,8 @@ declare enum ColorMode { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LayoutDirection { /** @@ -92,7 +96,8 @@ declare enum LayoutDirection { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LTR, @@ -107,7 +112,8 @@ declare enum LayoutDirection { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RTL, @@ -122,7 +128,8 @@ declare enum LayoutDirection { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Auto, } @@ -132,7 +139,8 @@ declare enum LayoutDirection { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ declare class Storage { /** @@ -142,7 +150,8 @@ declare class Storage { * @param { string } file * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(needCrossThread?: boolean, file?: string); @@ -153,7 +162,8 @@ declare class Storage { * @returns { string | undefined } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ get(key: string): string | undefined; @@ -161,19 +171,21 @@ declare class Storage { * Called when setting. * * @param { string } key - * @param { any } val + * @param { Object | undefined | null } val * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ - set(key: string, val: any): void; + set(key: string, val: Object | undefined | null): void; /** * Called when data is cleared. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ clear(): void; @@ -183,7 +195,8 @@ declare class Storage { * @param { string } key * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ delete(key: string): void; } diff --git a/api/@internal/component/ets/stepper.d.ts b/api/@internal/component/ets/stepper.d.ts index f81675778720e5127981089466b785adb87e7ccd..222293c3a301a3dea3822bb085c2ddedd7e0fb07 100644 --- a/api/@internal/component/ets/stepper.d.ts +++ b/api/@internal/component/ets/stepper.d.ts @@ -18,6 +18,45 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Bindable, CommonMethod } from './common' +/*** endif */ + +/** + * Declare the StepperOptions. + * + * @interface StepperOptions + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +interface StepperOptions { + /** + * Set the stepper index. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + */ + index?: number; + + /** + * Set the stepper index. + * + * @type { ?(number | Bindable) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + index?: number | Bindable; +} + /** * Declare the stepper. * @@ -40,7 +79,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface StepperInterface { /** @@ -70,7 +110,19 @@ interface StepperInterface { * @atomicservice * @since 11 */ - (value?: { index?: number }): StepperAttribute; + /** + * Called when the stepper component is used. + * + * Anonymous Object Rectification. + * @param { StepperOptions } value + * @returns { StepperAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + (value?: StepperOptions): StepperAttribute; } /** @@ -95,7 +147,8 @@ interface StepperInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class StepperAttribute extends CommonMethod { /** @@ -123,7 +176,8 @@ declare class StepperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish(callback: () => void): StepperAttribute; @@ -152,7 +206,8 @@ declare class StepperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onSkip(callback: () => void): StepperAttribute; @@ -181,7 +236,8 @@ declare class StepperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: (prevIndex: number, index: number) => void): StepperAttribute; @@ -210,7 +266,8 @@ declare class StepperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onNext(callback: (index: number, pendingIndex: number) => void): StepperAttribute; @@ -239,7 +296,8 @@ declare class StepperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onPrevious(callback: (index: number, pendingIndex: number) => void): StepperAttribute; } diff --git a/api/@internal/component/ets/stepper_item.d.ts b/api/@internal/component/ets/stepper_item.d.ts index 09673bc4925626bed75184c39964c2c1308f19cc..2d749fd67f153d9cfe9a2fbe096daee449b0f65f 100644 --- a/api/@internal/component/ets/stepper_item.d.ts +++ b/api/@internal/component/ets/stepper_item.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common' +/*** endif */ + /** * ItemState * @@ -25,14 +29,6 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 8 */ -/** - * ItemState - * - * @enum { number } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @since 10 - */ /** * ItemState * @@ -40,7 +36,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ItemState { /** @@ -62,7 +59,8 @@ declare enum ItemState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -85,7 +83,8 @@ declare enum ItemState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Disabled, @@ -108,7 +107,8 @@ declare enum ItemState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Waiting, @@ -131,7 +131,8 @@ declare enum ItemState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Skip, } @@ -158,7 +159,8 @@ declare enum ItemState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface StepperItemInterface { /** @@ -183,7 +185,8 @@ interface StepperItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): StepperItemAttribute; } @@ -210,7 +213,8 @@ interface StepperItemInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class StepperItemAttribute extends CommonMethod { /** @@ -238,7 +242,8 @@ declare class StepperItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ prevLabel(value: string): StepperItemAttribute; @@ -267,7 +272,8 @@ declare class StepperItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ nextLabel(value: string): StepperItemAttribute; @@ -296,7 +302,8 @@ declare class StepperItemAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ status(value?: ItemState): StepperItemAttribute; } diff --git a/api/@internal/component/ets/styled_string.d.ts b/api/@internal/component/ets/styled_string.d.ts index f5c622d31e9ee314d545885f7f9c5a7bfca3e201..6ee3e215ee9f88cf30a59b4bceb8e9b2d5c028ea 100644 --- a/api/@internal/component/ets/styled_string.d.ts +++ b/api/@internal/component/ets/styled_string.d.ts @@ -18,6 +18,19 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Callback, ShadowOptions, ClickEvent, Optional, PixelMap } from './common'; +import { TextAlign, FontStyle, FontWeight, TextDecorationType, TextDecorationStyle, WordBreak, TextOverflow, ImageFit, ImageSpanAlignment } from './enums'; +import { ResourceStr, ResourceColor, LengthMetrics, SizeOptions, Margin, Padding, BorderRadiuses, ColorFilter } from './units'; +import { TextBackgroundStyle } from './span'; +import { GestureEvent } from "./gesture"; +import { DrawingColorFilter } from './image'; +import { LeadingMarginPlaceholder } from './richEditor'; +import image from '../../@ohos.multimedia.image'; +import drawing from '../../@ohos.graphics.drawing'; +import { DrawContext } from '../../arkui/Graphics'; +/*** endif */ + /** * Defines the StyledStringMarshallingValue Type. * @@ -26,11 +39,11 @@ * @systemapi * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type StyledStringMarshallingValue = UserDataSpan; - /** * Defines the callback type used in marshalling. * @@ -41,7 +54,8 @@ declare type StyledStringMarshallingValue = UserDataSpan; * @systemapi * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ declare type StyledStringMarshallCallback = (marshallableVal: StyledStringMarshallingValue) => ArrayBuffer; @@ -55,7 +69,8 @@ declare type StyledStringMarshallCallback = (marshallableVal: StyledStringMarsha * @systemapi * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ declare type StyledStringUnmarshallCallback = (buf: ArrayBuffer) => StyledStringMarshallingValue; @@ -65,7 +80,8 @@ declare type StyledStringUnmarshallCallback = (buf: ArrayBuffer) => StyledString * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class StyledString { /** @@ -76,7 +92,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: string | ImageAttachment | CustomSpan, styles?: Array); @@ -88,7 +105,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly length: number; @@ -99,7 +117,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getString(): string; @@ -117,7 +136,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getStyles(start: number, length: number, styledKey?: StyledStringKey): Array; @@ -129,7 +149,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ equals(other: StyledString): boolean; @@ -146,7 +167,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ subStyledString(start: number, length?: number): StyledString; @@ -161,7 +183,8 @@ declare class StyledString { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static fromHtml(html: string): Promise; @@ -177,7 +200,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ static toHtml(styledString: StyledString): string; @@ -189,7 +213,8 @@ declare class StyledString { * @returns { ArrayBuffer } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ static marshalling(styledString: StyledString, callback: StyledStringMarshallCallback): ArrayBuffer; @@ -205,7 +230,8 @@ declare class StyledString { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ static unmarshalling(buffer: ArrayBuffer, callback: StyledStringUnmarshallCallback): Promise; @@ -216,7 +242,8 @@ declare class StyledString { * @returns { ArrayBuffer } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ static marshalling(styledString: StyledString): ArrayBuffer; @@ -231,7 +258,8 @@ declare class StyledString { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ static unmarshalling(buffer: ArrayBuffer): Promise; } @@ -243,7 +271,8 @@ declare class StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface StyleOptions { /** @@ -253,7 +282,8 @@ declare interface StyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: number; @@ -264,7 +294,8 @@ declare interface StyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ length?: number; @@ -275,7 +306,8 @@ declare interface StyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ styledKey: StyledStringKey; @@ -286,7 +318,8 @@ declare interface StyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ styledValue: StyledStringValue; } @@ -298,7 +331,8 @@ declare interface StyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SpanStyle { /** @@ -308,7 +342,8 @@ declare interface SpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start: number; @@ -319,7 +354,8 @@ declare interface SpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ length: number; @@ -330,7 +366,8 @@ declare interface SpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ styledKey: StyledStringKey; @@ -341,7 +378,8 @@ declare interface SpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ styledValue: StyledStringValue; } @@ -352,7 +390,8 @@ declare interface SpanStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextStyle { @@ -363,7 +402,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value?: TextStyleInterface); @@ -375,7 +415,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontColor?: ResourceColor; @@ -387,7 +428,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontFamily?: string; @@ -400,7 +442,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontSize?: number; @@ -412,7 +455,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontWeight?: number; @@ -424,7 +468,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fontStyle?: FontStyle; } @@ -436,7 +481,8 @@ declare class TextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextStyleInterface { /** @@ -446,7 +492,8 @@ declare interface TextStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor?: ResourceColor; @@ -457,7 +504,8 @@ declare interface TextStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily?: ResourceStr; @@ -468,7 +516,8 @@ declare interface TextStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: LengthMetrics; @@ -479,7 +528,8 @@ declare interface TextStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: number | FontWeight | string; @@ -490,7 +540,8 @@ declare interface TextStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle?: FontStyle; } @@ -501,7 +552,8 @@ declare interface TextStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DecorationStyle { @@ -512,7 +564,8 @@ declare class DecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: DecorationStyleInterface); @@ -524,7 +577,8 @@ declare class DecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly type: TextDecorationType; @@ -536,7 +590,8 @@ declare class DecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly color?: ResourceColor; @@ -548,7 +603,8 @@ declare class DecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly style?: TextDecorationStyle; } @@ -560,7 +616,8 @@ declare class DecorationStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DecorationStyleInterface { /** @@ -570,7 +627,8 @@ declare interface DecorationStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: TextDecorationType; @@ -581,7 +639,8 @@ declare interface DecorationStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -592,7 +651,8 @@ declare interface DecorationStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: TextDecorationStyle; } @@ -603,7 +663,8 @@ declare interface DecorationStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class BaselineOffsetStyle { @@ -614,7 +675,8 @@ declare class BaselineOffsetStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: LengthMetrics); @@ -627,7 +689,8 @@ declare class BaselineOffsetStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly baselineOffset: number; } @@ -638,7 +701,8 @@ declare class BaselineOffsetStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LetterSpacingStyle { @@ -649,7 +713,8 @@ declare class LetterSpacingStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: LengthMetrics); @@ -662,7 +727,8 @@ declare class LetterSpacingStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly letterSpacing: number; } @@ -673,7 +739,8 @@ declare class LetterSpacingStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextShadowStyle { @@ -684,7 +751,8 @@ declare class TextShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: ShadowOptions | Array); @@ -696,7 +764,8 @@ declare class TextShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly textShadow: Array; } @@ -707,7 +776,8 @@ declare class TextShadowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare class BackgroundColorStyle { @@ -718,7 +788,8 @@ declare class BackgroundColorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(textBackgroundStyle: TextBackgroundStyle); @@ -730,7 +801,8 @@ declare class BackgroundColorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ readonly textBackgroundStyle: TextBackgroundStyle; } @@ -741,7 +813,8 @@ declare class BackgroundColorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class GestureStyle { @@ -752,7 +825,8 @@ declare class GestureStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value?: GestureStyleInterface); } @@ -764,7 +838,8 @@ declare class GestureStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface GestureStyleInterface { /** @@ -774,7 +849,8 @@ declare interface GestureStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onClick?: Callback; @@ -785,7 +861,8 @@ declare interface GestureStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onLongPress?: Callback; } @@ -796,7 +873,8 @@ declare interface GestureStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ParagraphStyle { @@ -807,7 +885,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value?: ParagraphStyleInterface); @@ -819,7 +898,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly textAlign?: TextAlign; @@ -832,7 +912,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly textIndent?: number; @@ -844,7 +925,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly maxLines?: number; @@ -856,7 +938,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly overflow?: TextOverflow; @@ -868,7 +951,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly wordBreak?: WordBreak; @@ -880,7 +964,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly leadingMargin?: number | LeadingMarginPlaceholder; @@ -892,7 +977,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ readonly paragraphSpacing?: number; } @@ -904,7 +990,8 @@ declare class ParagraphStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ParagraphStyleInterface { /** @@ -914,7 +1001,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textAlign?: TextAlign; @@ -925,7 +1013,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textIndent?: LengthMetrics; @@ -936,7 +1025,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maxLines?: number; @@ -947,7 +1037,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ overflow?: TextOverflow; @@ -958,7 +1049,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak?: WordBreak; @@ -969,7 +1061,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ leadingMargin?: LengthMetrics | LeadingMarginPlaceholder; @@ -980,7 +1073,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ paragraphSpacing?: LengthMetrics; } @@ -991,7 +1085,8 @@ declare interface ParagraphStyleInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class LineHeightStyle { @@ -1002,7 +1097,8 @@ declare class LineHeightStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(lineHeight: LengthMetrics); @@ -1015,7 +1111,8 @@ declare class LineHeightStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly lineHeight: number; } @@ -1027,7 +1124,8 @@ declare class LineHeightStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare class UrlStyle { @@ -1038,7 +1136,8 @@ declare class UrlStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(url: string); @@ -1050,7 +1149,8 @@ declare class UrlStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ readonly url: string; } @@ -1076,7 +1176,8 @@ declare class UrlStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type StyledStringValue = TextStyle | DecorationStyle | BaselineOffsetStyle | LetterSpacingStyle | TextShadowStyle | GestureStyle | ImageAttachment | ParagraphStyle | LineHeightStyle | UrlStyle | CustomSpan | @@ -1089,7 +1190,8 @@ UserDataSpan | BackgroundColorStyle; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class MutableStyledString extends StyledString { /** @@ -1105,7 +1207,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replaceString(start: number, length: number, other: string): void; @@ -1121,7 +1224,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ insertString(start: number, other: string): void; @@ -1137,7 +1241,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeString(start: number, length: number): void; @@ -1152,7 +1257,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replaceStyle(spanStyle: SpanStyle): void; @@ -1164,7 +1270,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setStyle(spanStyle: SpanStyle): void; @@ -1181,7 +1288,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeStyle(start: number, length: number, styledKey: StyledStringKey): void; @@ -1197,7 +1305,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ removeStyles(start: number, length: number): void; @@ -1207,7 +1316,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clearStyles(): void; @@ -1224,7 +1334,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replaceStyledString(start: number, length: number, other: StyledString): void; @@ -1240,7 +1351,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ insertStyledString(start: number, other: StyledString): void; @@ -1251,7 +1363,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ appendStyledString(other: StyledString): void; } @@ -1264,7 +1377,8 @@ declare class MutableStyledString extends StyledString { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum StyledStringKey { /** @@ -1273,7 +1387,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FONT = 0, @@ -1283,7 +1398,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DECORATION = 1, @@ -1293,7 +1409,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BASELINE_OFFSET = 2, @@ -1303,7 +1420,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LETTER_SPACING = 3, @@ -1313,7 +1431,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_SHADOW = 4, @@ -1323,7 +1442,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LINE_HEIGHT = 5, @@ -1333,7 +1453,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND_COLOR = 6, @@ -1343,7 +1464,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ URL = 7, @@ -1353,7 +1475,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GESTURE = 100, @@ -1363,7 +1486,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PARAGRAPH_STYLE = 200, @@ -1373,7 +1497,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 300, @@ -1383,7 +1508,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CUSTOM_SPAN = 400, @@ -1393,7 +1519,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USER_DATA = 500, } @@ -1404,7 +1531,8 @@ declare enum StyledStringKey { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ImageAttachment { @@ -1430,6 +1558,18 @@ declare class ImageAttachment { */ constructor(attachment: Optional); + /** + * constructor supported by AttachmentType. + * + * @param { ImageAttachmentInterface | Optional } attachment - image attachment object. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(value: ImageAttachmentInterface | Optional); + /** * Get the image content of the StyledString. * @@ -1438,7 +1578,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly value: PixelMap; @@ -1450,7 +1591,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly size?: SizeOptions; @@ -1462,7 +1604,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly verticalAlign?: ImageSpanAlignment; @@ -1474,7 +1617,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly objectFit?: ImageFit; @@ -1486,7 +1630,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly layoutStyle?: ImageAttachmentLayoutStyle; @@ -1498,7 +1643,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ readonly colorFilter?: ColorFilterType; } @@ -1510,7 +1656,8 @@ declare class ImageAttachment { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ResourceImageAttachmentOptions { /** @@ -1520,7 +1667,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ resourceValue: Optional; @@ -1531,7 +1679,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ size?: SizeOptions; @@ -1542,7 +1691,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ verticalAlign?: ImageSpanAlignment; @@ -1553,7 +1703,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit?: ImageFit; @@ -1564,7 +1715,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ layoutStyle?: ImageAttachmentLayoutStyle; @@ -1575,7 +1727,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ colorFilter?: ColorFilterType; @@ -1587,7 +1740,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ syncLoad?: boolean; } @@ -1599,7 +1753,8 @@ declare interface ResourceImageAttachmentOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ImageAttachmentInterface { /** @@ -1609,7 +1764,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ value: PixelMap; @@ -1620,7 +1776,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size?: SizeOptions; @@ -1631,7 +1788,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ verticalAlign?: ImageSpanAlignment; @@ -1642,7 +1800,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit?: ImageFit; @@ -1653,7 +1812,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ layoutStyle?: ImageAttachmentLayoutStyle; @@ -1664,7 +1824,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ colorFilter?: ColorFilterType; } @@ -1676,7 +1837,8 @@ declare interface ImageAttachmentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type AttachmentType = ImageAttachmentInterface | ResourceImageAttachmentOptions; @@ -1687,7 +1849,8 @@ declare type AttachmentType = ImageAttachmentInterface | ResourceImageAttachment * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ColorFilterType = ColorFilter | DrawingColorFilter; @@ -1698,7 +1861,8 @@ declare type ColorFilterType = ColorFilter | DrawingColorFilter; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ImageAttachmentLayoutStyle { /** @@ -1708,7 +1872,8 @@ declare interface ImageAttachmentLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: LengthMetrics | Margin; @@ -1719,7 +1884,8 @@ declare interface ImageAttachmentLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ padding?: LengthMetrics | Padding; @@ -1730,7 +1896,8 @@ declare interface ImageAttachmentLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius?: LengthMetrics | BorderRadiuses; } @@ -1742,7 +1909,8 @@ declare interface ImageAttachmentLayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CustomSpanMetrics { /** @@ -1754,7 +1922,8 @@ declare interface CustomSpanMetrics { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -1766,7 +1935,8 @@ declare interface CustomSpanMetrics { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number; } @@ -1778,7 +1948,8 @@ declare interface CustomSpanMetrics { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CustomSpanDrawInfo { /** @@ -1789,7 +1960,8 @@ declare interface CustomSpanDrawInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -1801,7 +1973,8 @@ declare interface CustomSpanDrawInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineTop: number; @@ -1813,7 +1986,8 @@ declare interface CustomSpanDrawInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineBottom: number; @@ -1825,7 +1999,8 @@ declare interface CustomSpanDrawInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ baseline: number; } @@ -1837,7 +2012,8 @@ declare interface CustomSpanDrawInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface CustomSpanMeasureInfo { /** @@ -1848,7 +2024,8 @@ declare interface CustomSpanMeasureInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize: number; } @@ -1859,7 +2036,8 @@ declare interface CustomSpanMeasureInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare abstract class CustomSpan { /** @@ -1870,7 +2048,8 @@ declare abstract class CustomSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ abstract onMeasure(measureInfo: CustomSpanMeasureInfo) : CustomSpanMetrics; @@ -1882,7 +2061,8 @@ declare abstract class CustomSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ abstract onDraw(context: DrawContext, drawInfo: CustomSpanDrawInfo): void; @@ -1892,7 +2072,8 @@ declare abstract class CustomSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ invalidate(): void; } @@ -1903,6 +2084,7 @@ declare abstract class CustomSpan { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -declare abstract class UserDataSpan {} \ No newline at end of file +declare abstract class UserDataSpan {} diff --git a/api/@internal/component/ets/swiper.d.ts b/api/@internal/component/ets/swiper.d.ts index 6c7fbe0bfb86fac417189e68d99c9c56eb0dfaff..66df0bdc03888c1441d379c21acd74a29cdab4c9 100644 --- a/api/@internal/component/ets/swiper.d.ts +++ b/api/@internal/component/ets/swiper.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { IndicatorComponentController } from './indicatorcomponent'; +import { CommonMethod, Callback, ICurve, Optional } from './common'; +import { EdgeEffect, Curve, PageFlipMode } from './enums'; +import { Length, LengthMetrics, VoidCallback, ResourceColor, VP, Font } from './units'; +/*** endif */ + /** * Provides methods for switching components. * @@ -39,7 +46,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SwiperController { /** @@ -63,7 +71,8 @@ declare class SwiperController { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -92,6 +101,18 @@ declare class SwiperController { */ showNext(); + /** + * Called when the next child component is displayed. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + showNext(): void; + /** * Called when the previous subcomponent is displayed. * @@ -117,6 +138,18 @@ declare class SwiperController { */ showPrevious(); + /** + * Called when the previous subcomponent is displayed. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + showPrevious(): void; + /** * Controlling Swiper to change to the specified subcomponent. * @@ -145,6 +178,21 @@ declare class SwiperController { */ changeIndex(index: number, animationMode?: SwiperAnimationMode | boolean); + /** + * Controlling Swiper to change to the specified subcomponent. + * + * @param { number } index - the index of item to be redirected. + * @param { SwiperAnimationMode | boolean } [animationMode] - animation mode for changeIndex, + * true is equivalent to SwiperAnimationMode.DEFAULT_ANIMATION, false is equivalent to SwiperAnimationMode.NO_ANIMATION + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + changeIndex(index: number, animationMode?: SwiperAnimationMode | boolean): void; + /** * Called when need to stop the swiper animation. * @@ -183,6 +231,19 @@ declare class SwiperController { */ finishAnimation(callback?: VoidCallback); + /** + * Called when need to stop the swiper animation. + * + * @param { ?VoidCallback } callback + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + finishAnimation(callback?: VoidCallback): void; + /** * Called when need to preload specified child. * @@ -197,7 +258,8 @@ declare class SwiperController { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ preloadItems(indices: Optional>): Promise; } @@ -217,7 +279,8 @@ declare class SwiperController { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class Indicator { /** @@ -239,7 +302,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left(value: Length): T; @@ -262,7 +326,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top(value: Length): T; @@ -285,7 +350,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ right(value: Length): T; @@ -308,7 +374,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom(value: Length): T; @@ -336,7 +403,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start(value: LengthMetrics): T; @@ -350,7 +418,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end(value: LengthMetrics): T; @@ -373,7 +442,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static dot(): DotIndicator; @@ -396,7 +466,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static digit(): DigitIndicator; } @@ -418,7 +489,8 @@ declare class Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DotIndicator extends Indicator { /** @@ -436,7 +508,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -459,7 +532,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ itemWidth(value: Length): DotIndicator; @@ -482,7 +556,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ itemHeight(value: Length): DotIndicator; @@ -505,7 +580,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedItemWidth(value: Length): DotIndicator; @@ -528,7 +604,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedItemHeight(value: Length): DotIndicator; @@ -551,7 +628,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mask(value: boolean): DotIndicator; @@ -574,7 +652,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color(value: ResourceColor): DotIndicator; @@ -597,7 +676,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(value: ResourceColor): DotIndicator; @@ -609,7 +689,8 @@ declare class DotIndicator extends Indicator { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maxDisplayCount(maxDisplayCount: number): DotIndicator; @@ -622,7 +703,8 @@ declare class DotIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ space(space: LengthMetrics): DotIndicator; } @@ -651,7 +733,8 @@ declare class DotIndicator extends Indicator { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwiperAutoFill { /** @@ -667,7 +750,8 @@ declare interface SwiperAutoFill { * @type { VP } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 * @form */ minSize: VP; @@ -690,7 +774,8 @@ declare interface SwiperAutoFill { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class DigitIndicator extends Indicator { /** @@ -708,7 +793,8 @@ declare class DigitIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -731,7 +817,8 @@ declare class DigitIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): DigitIndicator; @@ -754,7 +841,8 @@ declare class DigitIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedFontColor(value: ResourceColor): DigitIndicator; @@ -777,7 +865,8 @@ declare class DigitIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ digitFont(value: Font): DigitIndicator; @@ -800,7 +889,8 @@ declare class DigitIndicator extends Indicator { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedDigitFont(value: Font): DigitIndicator; } @@ -819,7 +909,8 @@ declare class DigitIndicator extends Indicator { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ArrowStyle { /** @@ -838,7 +929,8 @@ declare interface ArrowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showBackground?: boolean; @@ -860,7 +952,8 @@ declare interface ArrowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ isSidebarMiddle?: boolean; @@ -882,7 +975,8 @@ declare interface ArrowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundSize?: Length; @@ -902,7 +996,8 @@ declare interface ArrowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -926,7 +1021,8 @@ declare interface ArrowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrowSize?: Length; @@ -946,7 +1042,8 @@ declare interface ArrowStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ arrowColor?: ResourceColor; } @@ -975,7 +1072,8 @@ declare interface ArrowStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SwiperDisplayMode { /** @@ -1015,7 +1113,8 @@ declare enum SwiperDisplayMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STRETCH, @@ -1065,7 +1164,8 @@ declare enum SwiperDisplayMode { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SwiperInterface { /** @@ -1095,7 +1195,8 @@ interface SwiperInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (controller?: SwiperController): SwiperAttribute; } @@ -1205,7 +1306,8 @@ declare interface IndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwiperAnimationEvent { /** @@ -1224,7 +1326,8 @@ declare interface SwiperAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ currentOffset: number; @@ -1244,7 +1347,8 @@ declare interface SwiperAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ targetOffset: number; @@ -1264,7 +1368,8 @@ declare interface SwiperAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ velocity: number; } @@ -1277,7 +1382,8 @@ declare interface SwiperAnimationEvent { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AutoPlayOptions { /** @@ -1289,7 +1395,8 @@ declare interface AutoPlayOptions { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ stopWhenTouched: boolean; } @@ -1300,7 +1407,8 @@ declare interface AutoPlayOptions { * @enum { number } SwiperNestedScrollMode * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SwiperNestedScrollMode { /** @@ -1308,7 +1416,8 @@ declare enum SwiperNestedScrollMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SELF_ONLY = 0, @@ -1317,7 +1426,8 @@ declare enum SwiperNestedScrollMode { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SELF_FIRST = 1, } @@ -1330,7 +1440,8 @@ declare enum SwiperNestedScrollMode { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SwiperAnimationMode { /** @@ -1340,7 +1451,8 @@ declare enum SwiperAnimationMode { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ NO_ANIMATION = 0, @@ -1351,7 +1463,8 @@ declare enum SwiperAnimationMode { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT_ANIMATION = 1, @@ -1363,7 +1476,8 @@ declare enum SwiperAnimationMode { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ FAST_ANIMATION = 2, } @@ -1379,7 +1493,8 @@ declare enum SwiperAnimationMode { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnSwiperAnimationStartCallback = (index: number, targetIndex: number, extraInfo: SwiperAnimationEvent) => void; @@ -1393,7 +1508,8 @@ declare type OnSwiperAnimationStartCallback = (index: number, targetIndex: numbe * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnSwiperAnimationEndCallback = (index: number, extraInfo: SwiperAnimationEvent) => void; @@ -1406,7 +1522,8 @@ declare type OnSwiperAnimationEndCallback = (index: number, extraInfo: SwiperAni * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnSwiperGestureSwipeCallback = (index: number, extraInfo: SwiperAnimationEvent) => void; @@ -1434,7 +1551,8 @@ declare type OnSwiperGestureSwipeCallback = (index: number, extraInfo: SwiperAni * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SwiperAttribute extends CommonMethod { /** @@ -1464,7 +1582,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ index(value: number): SwiperAttribute; @@ -1509,7 +1628,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ autoPlay(autoPlay: boolean, options: AutoPlayOptions): SwiperAttribute; @@ -1540,7 +1660,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interval(value: number): SwiperAttribute; @@ -1585,7 +1706,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ indicator(indicator: IndicatorComponentController | DotIndicator | DigitIndicator | boolean): SwiperAttribute; @@ -1607,7 +1729,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayArrow(value: ArrowStyle | boolean, isHoverShow?: boolean): SwiperAttribute; @@ -1638,7 +1761,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ loop(value: boolean): SwiperAttribute; @@ -1667,7 +1791,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration(value: number): SwiperAttribute; @@ -1698,7 +1823,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ vertical(value: boolean): SwiperAttribute; @@ -1729,7 +1855,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ itemSpace(value: number | string): SwiperAttribute; @@ -1760,7 +1887,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayMode(value: SwiperDisplayMode): SwiperAttribute; @@ -1791,7 +1919,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cachedCount(value: number): SwiperAttribute; @@ -1805,7 +1934,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ cachedCount(count: number, isShown: boolean): SwiperAttribute; @@ -1844,7 +1974,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ displayCount(value: number | string | SwiperAutoFill, swipeByGroup?: boolean): SwiperAttribute; @@ -1875,7 +2006,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ effectMode(value: EdgeEffect): SwiperAttribute; @@ -1906,7 +2038,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disableSwipe(value: boolean): SwiperAttribute; @@ -1941,7 +2074,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ curve(value: Curve | string | ICurve): SwiperAttribute; @@ -1983,7 +2117,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(event: Callback): SwiperAttribute; @@ -1996,7 +2131,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onSelected(event: Callback): SwiperAttribute; @@ -2039,7 +2175,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prevMargin(value: Length, ignoreBlank?: boolean): SwiperAttribute; @@ -2071,7 +2208,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ nextMargin(value: Length, ignoreBlank?: boolean): SwiperAttribute; @@ -2084,7 +2222,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onUnselected(event: Callback): SwiperAttribute; @@ -2132,7 +2271,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAnimationStart(event: OnSwiperAnimationStartCallback): SwiperAttribute; @@ -2178,7 +2318,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAnimationEnd(event: OnSwiperAnimationEndCallback): SwiperAttribute; @@ -2213,7 +2354,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onGestureSwipe(event: OnSwiperGestureSwipeCallback): SwiperAttribute; @@ -2225,7 +2367,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ nestedScroll(value: SwiperNestedScrollMode): SwiperAttribute; @@ -2237,7 +2380,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customContentTransition(transition: SwiperContentAnimatedTransition): SwiperAttribute; @@ -2253,7 +2397,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onContentDidScroll(handler: ContentDidScrollCallback): SwiperAttribute; @@ -2265,7 +2410,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ indicatorInteractive(value: boolean): SwiperAttribute; @@ -2278,7 +2424,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ pageFlipMode(mode: Optional): SwiperAttribute; @@ -2291,7 +2438,8 @@ declare class SwiperAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onContentWillScroll(handler: ContentWillScrollCallback): SwiperAttribute; } @@ -2303,7 +2451,8 @@ declare class SwiperAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwiperContentAnimatedTransition { /** @@ -2315,7 +2464,8 @@ declare interface SwiperContentAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ timeout?: number; @@ -2326,7 +2476,8 @@ declare interface SwiperContentAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transition: Callback; } @@ -2338,7 +2489,8 @@ declare interface SwiperContentAnimatedTransition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwiperContentTransitionProxy { /** @@ -2348,7 +2500,8 @@ declare interface SwiperContentTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectedIndex: number; @@ -2359,7 +2512,8 @@ declare interface SwiperContentTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -2370,7 +2524,8 @@ declare interface SwiperContentTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position: number; @@ -2381,7 +2536,8 @@ declare interface SwiperContentTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ mainAxisLength: number; @@ -2391,7 +2547,8 @@ declare interface SwiperContentTransitionProxy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ finishTransition(): void; } @@ -2404,7 +2561,8 @@ declare interface SwiperContentTransitionProxy { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwiperContentWillScrollResult { /** @@ -2415,7 +2573,8 @@ declare interface SwiperContentWillScrollResult { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ currentIndex: number; @@ -2427,7 +2586,8 @@ declare interface SwiperContentWillScrollResult { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ comingIndex: number; @@ -2440,7 +2600,8 @@ declare interface SwiperContentWillScrollResult { * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; } @@ -2456,7 +2617,8 @@ declare interface SwiperContentWillScrollResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ContentDidScrollCallback = (selectedIndex: number, index: number, position: number, mainAxisLength: number) => void; @@ -2470,7 +2632,8 @@ declare type ContentDidScrollCallback = (selectedIndex: number, index: number, p * @crossplatform * @form * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ContentWillScrollCallback = (result: SwiperContentWillScrollResult) => boolean; diff --git a/api/@internal/component/ets/symbol_span.d.ts b/api/@internal/component/ets/symbol_span.d.ts index cac42f630020394940dcf876ed0298c06e8486bb..93c33981265f9dbbe1e2e936493e570acaf34a8d 100644 --- a/api/@internal/component/ets/symbol_span.d.ts +++ b/api/@internal/component/ets/symbol_span.d.ts @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from './../../../api/global/resource'; +import { CommonMethod, AttributeModifier } from './common'; +import { ResourceColor } from './units'; +import { FontWeight } from './enums'; +import { SymbolEffectStrategy, SymbolRenderingStrategy } from './symbolglyph'; +/*** endif */ + /** * Provides an interface for SymbolSpan. * @@ -32,7 +40,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface SymbolSpanInterface { /** @@ -51,7 +60,8 @@ interface SymbolSpanInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ (value: Resource): SymbolSpanAttribute; } @@ -70,7 +80,8 @@ interface SymbolSpanInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SymbolSpanAttribute extends CommonMethod { /** @@ -89,7 +100,8 @@ declare class SymbolSpanAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: number | string | Resource): SymbolSpanAttribute; @@ -109,7 +121,8 @@ declare class SymbolSpanAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: Array): SymbolSpanAttribute; @@ -129,7 +142,8 @@ declare class SymbolSpanAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): SymbolSpanAttribute; @@ -149,7 +163,8 @@ declare class SymbolSpanAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ effectStrategy(value: SymbolEffectStrategy): SymbolSpanAttribute; @@ -169,7 +184,8 @@ declare class SymbolSpanAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ renderingStrategy(value: SymbolRenderingStrategy): SymbolSpanAttribute; @@ -180,7 +196,8 @@ declare class SymbolSpanAttribute extends CommonMethod { * @returns { SymbolSpanAttribute } the attribute of the SymbolSpanAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ attributeModifier(modifier: AttributeModifier): SymbolSpanAttribute; } diff --git a/api/@internal/component/ets/symbolglyph.d.ts b/api/@internal/component/ets/symbolglyph.d.ts index f4db61b089834fa76dfaf408c902552c7427b32a..c04c0f918b42726fe7a78c279c13076f540f0ff9 100644 --- a/api/@internal/component/ets/symbolglyph.d.ts +++ b/api/@internal/component/ets/symbolglyph.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource'; +import { ResourceColor } from './units'; +import { FontWeight } from './enums'; +import { CommonMethod,Optional } from "./common"; +/*** endif */ + /** * Provides an interface for SymbolGlyph. * @@ -32,7 +39,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SymbolGlyphInterface { /** @@ -51,7 +59,8 @@ interface SymbolGlyphInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ (value?: Resource): SymbolGlyphAttribute; } @@ -70,7 +79,8 @@ interface SymbolGlyphInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SymbolRenderingStrategy { /** @@ -85,7 +95,8 @@ declare enum SymbolRenderingStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SINGLE = 0, @@ -101,7 +112,8 @@ declare enum SymbolRenderingStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MULTIPLE_COLOR = 1, @@ -117,7 +129,8 @@ declare enum SymbolRenderingStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MULTIPLE_OPACITY = 2, } @@ -136,7 +149,8 @@ declare enum SymbolRenderingStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SymbolEffectStrategy { /** @@ -151,7 +165,8 @@ declare enum SymbolEffectStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -167,7 +182,8 @@ declare enum SymbolEffectStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SCALE = 1, @@ -183,7 +199,8 @@ declare enum SymbolEffectStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ HIERARCHICAL = 2, } @@ -195,7 +212,8 @@ declare enum SymbolEffectStrategy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EffectDirection { /** @@ -204,7 +222,8 @@ declare enum EffectDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DOWN = 0, /** @@ -213,7 +232,8 @@ declare enum EffectDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UP = 1, } @@ -225,7 +245,8 @@ declare enum EffectDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EffectScope { /** @@ -234,7 +255,8 @@ declare enum EffectScope { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LAYER = 0, /** @@ -243,7 +265,8 @@ declare enum EffectScope { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WHOLE = 1, } @@ -255,7 +278,8 @@ declare enum EffectScope { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EffectFillStyle { /** @@ -264,7 +288,8 @@ declare enum EffectFillStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CUMULATIVE = 0, @@ -274,7 +299,8 @@ declare enum EffectFillStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ITERATIVE = 1, } @@ -285,7 +311,8 @@ declare enum EffectFillStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SymbolEffect { } @@ -297,7 +324,8 @@ declare class SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScaleSymbolEffect extends SymbolEffect { /** @@ -308,7 +336,8 @@ declare class ScaleSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(scope?: EffectScope, direction?: EffectDirection); @@ -319,7 +348,8 @@ declare class ScaleSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scope?: EffectScope; @@ -330,7 +360,8 @@ declare class ScaleSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ direction?: EffectDirection; } @@ -342,7 +373,8 @@ declare class ScaleSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class HierarchicalSymbolEffect extends SymbolEffect { /** @@ -352,7 +384,8 @@ declare class HierarchicalSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(fillStyle?: EffectFillStyle); @@ -363,7 +396,8 @@ declare class HierarchicalSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fillStyle?: EffectFillStyle; } @@ -375,7 +409,8 @@ declare class HierarchicalSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class AppearSymbolEffect extends SymbolEffect { /** @@ -385,7 +420,8 @@ declare class AppearSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(scope?: EffectScope); @@ -396,7 +432,8 @@ declare class AppearSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scope?: EffectScope; } @@ -408,7 +445,8 @@ declare class AppearSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class DisappearSymbolEffect extends SymbolEffect { /** @@ -418,7 +456,8 @@ declare class DisappearSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(scope?: EffectScope); @@ -429,7 +468,8 @@ declare class DisappearSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scope?: EffectScope; } @@ -441,7 +481,8 @@ declare class DisappearSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class BounceSymbolEffect extends SymbolEffect { /** @@ -452,7 +493,8 @@ declare class BounceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(scope?: EffectScope, direction?: EffectDirection); @@ -463,7 +505,8 @@ declare class BounceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scope?: EffectScope; @@ -474,7 +517,8 @@ declare class BounceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ direction?: EffectDirection; } @@ -486,7 +530,8 @@ declare class BounceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class ReplaceSymbolEffect extends SymbolEffect { /** @@ -496,7 +541,8 @@ declare class ReplaceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(scope?: EffectScope); @@ -507,7 +553,8 @@ declare class ReplaceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scope?: EffectScope; } @@ -519,7 +566,8 @@ declare class ReplaceSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class PulseSymbolEffect extends SymbolEffect { } @@ -538,7 +586,8 @@ declare class PulseSymbolEffect extends SymbolEffect { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SymbolGlyphAttribute extends CommonMethod { /** @@ -557,7 +606,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: number | string | Resource): SymbolGlyphAttribute; @@ -577,7 +627,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: Array): SymbolGlyphAttribute; @@ -597,7 +648,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): SymbolGlyphAttribute; @@ -617,7 +669,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ effectStrategy(value: SymbolEffectStrategy): SymbolGlyphAttribute; @@ -637,7 +690,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ renderingStrategy(value: SymbolRenderingStrategy): SymbolGlyphAttribute; @@ -667,6 +721,21 @@ declare class SymbolGlyphAttribute extends CommonMethod { */ symbolEffect(symbolEffect: SymbolEffect, triggerValue?: number): SymbolGlyphAttribute; + /** + * Define effect options for SymbolGlyph. + * + * @param { SymbolEffect } [symbolEffect] - The symbol effect type + * @param { boolean | number } [triggerValue] - The trigger of the effect + * @returns { SymbolGlyphAttribute } The attribute of the SymbolGlyph. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + symbolEffect(symbolEffect: SymbolEffect, triggerValue?: boolean | number): SymbolGlyphAttribute; + /** * Called when the minimum font scale of the font is set. * @@ -674,7 +743,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @returns { SymbolGlyphAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: Optional): SymbolGlyphAttribute; @@ -685,7 +755,8 @@ declare class SymbolGlyphAttribute extends CommonMethod { * @returns { SymbolGlyphAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: Optional): SymbolGlyphAttribute; } diff --git a/api/@internal/component/ets/tab_content.d.ts b/api/@internal/component/ets/tab_content.d.ts index 6a1bc94f6c9c2c13a54ad4e67238e8cc43dbe97f..4b1bc2733a0de6f87337025425c633900ec4d9be 100644 --- a/api/@internal/component/ets/tab_content.d.ts +++ b/api/@internal/component/ets/tab_content.d.ts @@ -18,6 +18,15 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod } from './common'; +import { CustomBuilder } from './builder' +import { TextHeightAdaptivePolicy, TextOverflow, VerticalAlign } from './enums'; +import { Dimension, Font, Length, LocalizedPadding, Padding, Resource, ResourceColor, ResourceStr, VoidCallback } from './units'; +import { ComponentContent } from '../ComponentContent' +import { SymbolGlyphModifier } from '../SymbolGlyphModifier'; +/*** endif */ + /** * Enum for the mode of the tab bar when selected. * @@ -33,7 +42,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SelectedMode { /** @@ -49,7 +59,8 @@ declare enum SelectedMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ INDICATOR, @@ -66,7 +77,8 @@ declare enum SelectedMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BOARD } @@ -86,7 +98,8 @@ declare enum SelectedMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LayoutMode { @@ -103,7 +116,8 @@ declare enum LayoutMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, /** @@ -119,7 +133,8 @@ declare enum LayoutMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ VERTICAL = 1, @@ -136,7 +151,8 @@ declare enum LayoutMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HORIZONTAL = 2 } @@ -266,6 +282,77 @@ interface IndicatorStyle { marginTop?: Length; } +/** + * Provide an interface for the style of an SubTabBar indicator including color, height, width, border radius + * and margin top + * + * @interface SubTabBarIndicatorStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface SubTabBarIndicatorStyle { + /** + * Define the color of the indicator + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + color?: ResourceColor; + + /** + * Define the height of the indicator + * + * @type { ?Length } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + height?: Length; + + /** + * Define the width of the indicator. + * If it is 0, the width will be equal to the width of the content + * + * @type { ?Length } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + width?: Length; + + /** + * Define the border radius of the indicator + * + * @type { ?Length } + * @default 0 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + borderRadius?: Length; + + /** + * Define the margin top of the indicator + * + * @type { ?Length } + * @default 8 + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + marginTop?: Length; +} + /** * Provide an interface for the style of an indicator including border radius * @@ -281,7 +368,8 @@ interface IndicatorStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface BoardStyle { /** @@ -299,7 +387,8 @@ interface BoardStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ borderRadius?: Length; } @@ -459,6 +548,115 @@ declare interface LabelStyle { unselectedColor?: ResourceColor; } +/** + * TabBarLabelStyle object. + * + * @interface TabBarLabelStyle + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface TabBarLabelStyle { + + /** + * overflow mode. + * + * @type { ?TextOverflow } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + overflow?: TextOverflow; + + /** + * Label max lines. + * + * @type { ?number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + maxLines?: number; + + /** + * Min font size for adapted height. + * + * @type { ?(number | ResourceStr) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + minFontSize?: number | ResourceStr; + + /** + * Max font size for adapted height. + * + * @type { ?(number | ResourceStr) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + maxFontSize?: number | ResourceStr; + + /** + * Adapt text height option. + * + * @type { ?TextHeightAdaptivePolicy } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + heightAdaptivePolicy?: TextHeightAdaptivePolicy; + + /** + * Font style. + * + * @type { ?Font } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + font?: Font; + + /** + * The text color of the selected tab bar. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + selectedColor?: ResourceColor; + + /** + * The text color of the unselected tab bar. + * + * @type { ?ResourceColor } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + unselectedColor?: ResourceColor; +} + /** * TabBarIconStyle object. * @@ -466,7 +664,8 @@ declare interface LabelStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TabBarIconStyle { /** @@ -476,7 +675,8 @@ declare interface TabBarIconStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor?: ResourceColor; @@ -487,7 +687,8 @@ declare interface TabBarIconStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ unselectedColor?: ResourceColor; } @@ -497,7 +698,8 @@ declare interface TabBarIconStyle { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TabBarSymbol { /** @@ -506,7 +708,8 @@ declare class TabBarSymbol { * @type { SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ normal: SymbolGlyphModifier; @@ -516,7 +719,8 @@ declare class TabBarSymbol { * @type { ?SymbolGlyphModifier } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selected?: SymbolGlyphModifier; } @@ -528,7 +732,8 @@ declare class TabBarSymbol { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TabBarOptions { /** @@ -553,7 +758,8 @@ declare interface TabBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: string | Resource; @@ -579,7 +785,8 @@ declare interface TabBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ text?: string | Resource } @@ -603,7 +810,8 @@ declare interface TabBarOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SubTabBarStyle { /** @@ -628,7 +836,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(content: ResourceStr); /** @@ -638,7 +847,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(content: ResourceStr | ComponentContent); @@ -661,7 +871,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static of(content: ResourceStr): SubTabBarStyle; /** @@ -673,7 +884,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static of(content: ResourceStr | ComponentContent): SubTabBarStyle; @@ -698,6 +910,18 @@ declare class SubTabBarStyle { */ indicator(value: IndicatorStyle): SubTabBarStyle; + /** + * Set the style of the indicator when selected + * + * @param { SubTabBarIndicatorStyle } style - indicates the indicator style of the sub tab bar + * @returns { SubTabBarStyle } the style of the sub tab bar + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + indicator(style: SubTabBarIndicatorStyle): SubTabBarStyle; + /** * Set the mode of the indicator when selected * @@ -715,7 +939,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedMode(value: SelectedMode): SubTabBarStyle; @@ -736,7 +961,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ board(value: BoardStyle): SubTabBarStyle; @@ -761,6 +987,18 @@ declare class SubTabBarStyle { */ labelStyle(value: LabelStyle): SubTabBarStyle; + /** + * Set the label style of the sub tab bar + * + * @param { TabBarLabelStyle } style - indicates the label style of the sub tab bar + * @returns { SubTabBarStyle } the style of the sub tab bar + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + labelStyle(style: TabBarLabelStyle): SubTabBarStyle; + /** * Set the padding of the sub tab bar * @@ -778,7 +1016,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ padding(value: Padding | Dimension): SubTabBarStyle; @@ -790,7 +1029,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ padding(padding: LocalizedPadding): SubTabBarStyle; @@ -811,7 +1051,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id(value: string): SubTabBarStyle; } @@ -835,7 +1076,8 @@ declare class SubTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class BottomTabBarStyle { /** @@ -873,7 +1115,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(icon: ResourceStr | TabBarSymbol, text: ResourceStr); @@ -910,7 +1153,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static of(icon: ResourceStr | TabBarSymbol, text: ResourceStr): BottomTabBarStyle; @@ -935,6 +1179,18 @@ declare class BottomTabBarStyle { */ labelStyle(value: LabelStyle): BottomTabBarStyle; + /** + * Set the label style of the bottom tab bar + * + * @param { TabBarLabelStyle } style - indicates the label style of the bottom tab bar + * @returns { BottomTabBarStyle } the style of the bottom tab bar + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + labelStyle(style: TabBarLabelStyle): BottomTabBarStyle; + /** * Set the padding of the bottom tab bar * @@ -962,7 +1218,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ padding(value: Padding | Dimension | LocalizedPadding): BottomTabBarStyle; @@ -983,7 +1240,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ layoutMode(value: LayoutMode): BottomTabBarStyle; @@ -1004,7 +1262,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ verticalAlign(value: VerticalAlign): BottomTabBarStyle; @@ -1025,7 +1284,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ symmetricExtensible(value: boolean): BottomTabBarStyle; @@ -1046,7 +1306,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id(value: string): BottomTabBarStyle; @@ -1058,7 +1319,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconStyle(style: TabBarIconStyle): BottomTabBarStyle; } @@ -1085,7 +1347,8 @@ declare class BottomTabBarStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TabContentInterface { /** @@ -1110,7 +1373,8 @@ interface TabContentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (): TabContentAttribute; } @@ -1137,7 +1401,8 @@ interface TabContentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TabContentAttribute extends CommonMethod { /** @@ -1225,7 +1490,8 @@ declare class TabContentAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ tabBar(content: ComponentContent | SubTabBarStyle | BottomTabBarStyle | string | Resource | CustomBuilder | TabBarOptions): TabContentAttribute; @@ -1237,7 +1503,8 @@ declare class TabContentAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillShow(event: VoidCallback): TabContentAttribute; @@ -1248,7 +1515,8 @@ declare class TabContentAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillHide(event: VoidCallback): TabContentAttribute; } diff --git a/api/@internal/component/ets/tabs.d.ts b/api/@internal/component/ets/tabs.d.ts index 8558e19f132b809cafc3d0dccf8ea0aa8a33338a..015fabcf27c782646be3424015095de2fd3fa9d3 100644 --- a/api/@internal/component/ets/tabs.d.ts +++ b/api/@internal/component/ets/tabs.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { BackgroundBlurStyleOptions, BackgroundEffectOptions, BlurStyle, Callback, CommonMethod, Optional, TranslateOptions, DividerStyle } from './common'; +import { EdgeEffect, PageFlipMode } from './enums'; +import { Dimension, Length, ResourceColor } from './units'; +import { CommonModifier } from "../CommonModifier"; +/*** endif */ + /** * CommonModifier * @@ -51,7 +58,8 @@ declare type CommonModifier = import('../api/arkui/CommonModifier').CommonModifi * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BarMode { /** @@ -73,7 +81,8 @@ declare enum BarMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Scrollable = 0, @@ -96,7 +105,8 @@ declare enum BarMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Fixed = 1, } @@ -108,7 +118,8 @@ declare enum BarMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AnimationMode { /** @@ -117,7 +128,8 @@ declare enum AnimationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_FIRST = 0, @@ -127,7 +139,8 @@ declare enum AnimationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_FIRST = 1, @@ -137,7 +150,8 @@ declare enum AnimationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NO_ANIMATION = 2, @@ -147,7 +161,8 @@ declare enum AnimationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_FIRST_WITH_JUMP = 3, @@ -157,7 +172,8 @@ declare enum AnimationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_FIRST_WITH_JUMP = 4, } @@ -184,7 +200,8 @@ declare enum AnimationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BarPosition { /** @@ -206,7 +223,8 @@ declare enum BarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Start, @@ -229,7 +247,8 @@ declare enum BarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ End, } @@ -249,7 +268,8 @@ declare enum BarPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum LayoutStyle { /** @@ -265,7 +285,8 @@ declare enum LayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ALWAYS_CENTER = 0, /** @@ -281,7 +302,8 @@ declare enum LayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ALWAYS_AVERAGE_SPLIT = 1, /** @@ -299,7 +321,8 @@ declare enum LayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPACE_BETWEEN_OR_CENTER = 2 } @@ -311,7 +334,8 @@ declare enum LayoutStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TabsCacheMode { /** @@ -320,7 +344,8 @@ declare enum TabsCacheMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CACHE_BOTH_SIDE = 0, @@ -330,7 +355,8 @@ declare enum TabsCacheMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CACHE_LATEST_SWITCHED = 1 } @@ -354,7 +380,8 @@ declare enum TabsCacheMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TabsController { /** @@ -376,7 +403,8 @@ declare class TabsController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -402,7 +430,8 @@ declare class TabsController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ changeIndex(value: number): void; @@ -418,7 +447,8 @@ declare class TabsController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ preloadItems(indices: Optional>): Promise; @@ -429,7 +459,8 @@ declare class TabsController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ setTabBarTranslate(translate: TranslateOptions): void; @@ -440,7 +471,8 @@ declare class TabsController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ setTabBarOpacity(opacity: number): void; } @@ -452,7 +484,8 @@ declare class TabsController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TabsOptions { /** @@ -477,7 +510,8 @@ declare interface TabsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barPosition?: BarPosition; @@ -503,7 +537,8 @@ declare interface TabsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ index?: number; @@ -529,7 +564,8 @@ declare interface TabsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ controller?: TabsController @@ -540,7 +576,8 @@ declare interface TabsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ barModifier?: CommonModifier } @@ -567,7 +604,8 @@ declare interface TabsOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TabsInterface { /** @@ -605,7 +643,8 @@ interface TabsInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: TabsOptions): TabsAttribute; } @@ -728,7 +767,8 @@ interface DividerStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TabsAnimationEvent { /** @@ -748,7 +788,8 @@ declare interface TabsAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ currentOffset: number; @@ -769,7 +810,8 @@ declare interface TabsAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ targetOffset: number; @@ -790,7 +832,8 @@ declare interface TabsAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ velocity: number; } @@ -810,7 +853,8 @@ declare interface TabsAnimationEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface BarGridColumnOptions { /** @@ -828,7 +872,8 @@ interface BarGridColumnOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sm?: number; @@ -847,7 +892,8 @@ interface BarGridColumnOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ md?: number; @@ -866,7 +912,8 @@ interface BarGridColumnOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ lg?: number; @@ -885,7 +932,8 @@ interface BarGridColumnOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: Dimension; @@ -904,7 +952,8 @@ interface BarGridColumnOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ gutter?: Dimension; } @@ -924,7 +973,8 @@ interface BarGridColumnOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScrollableBarModeOptions { /** @@ -942,7 +992,8 @@ interface ScrollableBarModeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: Dimension; @@ -961,7 +1012,8 @@ interface ScrollableBarModeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ nonScrollableLayoutStyle?: LayoutStyle; } @@ -976,7 +1028,8 @@ interface ScrollableBarModeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTabsAnimationStartCallback = (index: number, targetIndex: number, extraInfo: TabsAnimationEvent) => void; @@ -989,7 +1042,8 @@ declare type OnTabsAnimationStartCallback = (index: number, targetIndex: number, * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTabsAnimationEndCallback = (index: number, extraInfo: TabsAnimationEvent) => void; @@ -1002,7 +1056,8 @@ declare type OnTabsAnimationEndCallback = (index: number, extraInfo: TabsAnimati * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTabsGestureSwipeCallback = (index: number, extraInfo: TabsAnimationEvent) => void; @@ -1016,7 +1071,8 @@ declare type OnTabsGestureSwipeCallback = (index: number, extraInfo: TabsAnimati * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type TabsCustomContentTransitionCallback = (from: number, to: number) => TabContentAnimatedTransition | undefined; @@ -1032,7 +1088,8 @@ declare type TabsCustomContentTransitionCallback = (from: number, to: number) => * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTabsContentWillChangeCallback = (currentIndex: number, comingIndex: number) => boolean; @@ -1058,7 +1115,8 @@ declare type OnTabsContentWillChangeCallback = (currentIndex: number, comingInde * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TabsAttribute extends CommonMethod { /** @@ -1086,7 +1144,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ vertical(value: boolean): TabsAttribute; @@ -1115,7 +1174,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barPosition(value: BarPosition): TabsAttribute; @@ -1144,7 +1204,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scrollable(value: boolean): TabsAttribute; @@ -1219,7 +1280,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barMode(value: BarMode, options?: ScrollableBarModeOptions): TabsAttribute; @@ -1260,7 +1322,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barWidth(value: Length): TabsAttribute; @@ -1301,7 +1364,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barHeight(value: Length): TabsAttribute; @@ -1330,7 +1394,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ animationDuration(value: number): TabsAttribute; @@ -1342,7 +1407,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ animationMode(mode: Optional): TabsAttribute; @@ -1354,7 +1420,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ edgeEffect(edgeEffect: Optional): TabsAttribute; @@ -1393,7 +1460,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(event: Callback): TabsAttribute; @@ -1405,7 +1473,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onSelected(event: Callback): TabsAttribute; @@ -1436,7 +1505,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onTabBarClick(event: Callback): TabsAttribute; @@ -1448,7 +1518,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onUnselected(event: Callback): TabsAttribute; @@ -1485,7 +1556,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAnimationStart(handler: OnTabsAnimationStartCallback): TabsAttribute; @@ -1520,7 +1592,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onAnimationEnd(handler: OnTabsAnimationEndCallback): TabsAttribute; @@ -1555,7 +1628,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onGestureSwipe(handler: OnTabsGestureSwipeCallback): TabsAttribute; @@ -1576,7 +1650,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fadingEdge(value: boolean): TabsAttribute; @@ -1597,7 +1672,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ divider(value: DividerStyle | null): TabsAttribute; @@ -1617,7 +1693,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barOverlap(value: boolean): TabsAttribute; @@ -1637,7 +1714,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barBackgroundColor(value: ResourceColor): TabsAttribute; @@ -1658,7 +1736,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barGridAlign(value: BarGridColumnOptions): TabsAttribute; @@ -1694,7 +1773,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ customContentTransition(delegate: TabsCustomContentTransitionCallback): TabsAttribute; @@ -1706,7 +1786,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barBackgroundBlurStyle(value: BlurStyle): TabsAttribute; @@ -1719,7 +1800,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ barBackgroundBlurStyle(style: BlurStyle, options: BackgroundBlurStyleOptions): TabsAttribute; @@ -1731,7 +1813,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ barBackgroundEffect(options: BackgroundEffectOptions): TabsAttribute; @@ -1743,7 +1826,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ pageFlipMode(mode: Optional): TabsAttribute; @@ -1769,7 +1853,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onContentWillChange(handler: OnTabsContentWillChangeCallback): TabsAttribute; @@ -1782,7 +1867,8 @@ declare class TabsAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ cachedMaxCount(count: number, mode: TabsCacheMode): TabsAttribute; } @@ -1804,7 +1890,8 @@ declare class TabsAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TabContentAnimatedTransition { /** @@ -1828,7 +1915,8 @@ declare interface TabContentAnimatedTransition { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ timeout?: number; @@ -1859,7 +1947,8 @@ declare interface TabContentAnimatedTransition { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ transition: Callback; } @@ -1881,7 +1970,8 @@ declare interface TabContentAnimatedTransition { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TabContentTransitionProxy { /** @@ -1901,7 +1991,8 @@ declare interface TabContentTransitionProxy { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ from: number; @@ -1922,7 +2013,8 @@ declare interface TabContentTransitionProxy { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ to: number; @@ -1941,7 +2033,8 @@ declare interface TabContentTransitionProxy { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ finishTransition(): void; } diff --git a/api/@internal/component/ets/text.d.ts b/api/@internal/component/ets/text.d.ts index 4e083f0378f2585d7014b47a1bc388ee80ad887c..8655b6b22f632d5136333d1708345acd6768a0cc 100644 --- a/api/@internal/component/ets/text.d.ts +++ b/api/@internal/component/ets/text.d.ts @@ -18,6 +18,16 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonMethod, ShadowOptions,Optional,Callback} from "./common"; +import { CustomBuilder } from './builder' +import { EllipsisMode, TextCase, LineBreakStrategy, TextAlign, FontStyle, FontWeight, WordBreak, TextOverflow, CopyOptions, TextHeightAdaptivePolicy, TextSelectableMode} from './enums'; +import { Resource, ResourceColor, Font, Length, LengthMetrics } from './units'; +import { TextDataDetectorConfig, LayoutManager, FontSettingOptions, EditMenuOptions } from "./textCommon"; +import { DecorationStyleInterface, StyledString } from "./styledString"; +import { SelectionMenuOptions } from './richEditor' +/*** endif */ + /** * Text overflow options. * @@ -26,7 +36,8 @@ * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextOverflowOptions { /** @@ -61,7 +72,8 @@ declare interface TextOverflowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ overflow: TextOverflow; } @@ -98,7 +110,8 @@ declare interface TextOverflowOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface TextInterface { /** @@ -138,7 +151,8 @@ interface TextInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ (content?: string | Resource, value?: TextOptions): TextAttribute; } @@ -167,7 +181,8 @@ interface TextInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextAttribute extends CommonMethod { /** @@ -200,7 +215,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ font(fontValue: Font, options?: FontSettingOptions): TextAttribute; @@ -240,7 +256,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): TextAttribute; @@ -280,7 +297,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: number | string | Resource): TextAttribute; @@ -320,7 +338,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize(value: number | string | Resource): TextAttribute; @@ -360,7 +379,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontSize(value: number | string | Resource): TextAttribute; @@ -371,7 +391,8 @@ declare class TextAttribute extends CommonMethod { * @returns { TextAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: number | Resource): TextAttribute; @@ -382,7 +403,8 @@ declare class TextAttribute extends CommonMethod { * @returns { TextAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: number | Resource): TextAttribute; @@ -422,7 +444,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): TextAttribute; @@ -480,6 +503,22 @@ declare class TextAttribute extends CommonMethod { */ fontWeight(weight: number | FontWeight | string, options?: FontSettingOptions): TextAttribute; + + /** + * Called when the font weight is set. + * + * @param { number | FontWeight | string } weight + * @param { FontSettingOptions } options - font setting options. + * @returns { TextAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @arkts 1.2 + * @since 20 + */ + fontWeight(weight: number | FontWeight | string, options?: FontSettingOptions): TextAttribute; + /** * Set font line spacing. * @@ -488,7 +527,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ lineSpacing(value: LengthMetrics): TextAttribute; @@ -528,7 +568,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textAlign(value: TextAlign): TextAttribute; @@ -568,7 +609,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight(value: number | string | Resource): TextAttribute; @@ -619,7 +661,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ textOverflow(options: TextOverflowOptions): TextAttribute; @@ -659,7 +702,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: string | Resource): TextAttribute; @@ -699,7 +743,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ maxLines(value: number): TextAttribute; @@ -750,7 +795,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ decoration(value: DecorationStyleInterface): TextAttribute; @@ -790,7 +836,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing(value: number | string): TextAttribute; @@ -830,7 +877,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textCase(value: TextCase): TextAttribute; @@ -870,7 +918,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ baselineOffset(value: number | string): TextAttribute; @@ -902,7 +951,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ copyOption(value: CopyOptions): TextAttribute; @@ -931,7 +981,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ draggable(value: boolean): TextAttribute; @@ -954,7 +1005,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textShadow(value: ShadowOptions | Array): TextAttribute; @@ -975,7 +1027,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ heightAdaptivePolicy(value: TextHeightAdaptivePolicy): TextAttribute; @@ -996,7 +1049,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textIndent(value: Length): TextAttribute; @@ -1008,7 +1062,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak(value: WordBreak): TextAttribute; @@ -1020,7 +1075,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ lineBreakStrategy(strategy: LineBreakStrategy): TextAttribute; @@ -1032,7 +1088,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onCopy(callback: (value: string) => void): TextAttribute; @@ -1045,7 +1102,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ selection(selectionStart: number, selectionEnd: number): TextAttribute; @@ -1057,7 +1115,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ caretColor(color: ResourceColor): TextAttribute; @@ -1069,7 +1128,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ selectedBackgroundColor(color: ResourceColor): TextAttribute; @@ -1090,7 +1150,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ellipsisMode(value: EllipsisMode): TextAttribute; @@ -1109,7 +1170,8 @@ declare class TextAttribute extends CommonMethod { * @returns { TextAttribute } The attribute of the text. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enableDataDetector(enable: boolean): TextAttribute; @@ -1128,7 +1190,8 @@ declare class TextAttribute extends CommonMethod { * @returns { TextAttribute } The attribute of the text. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ dataDetectorConfig(config: TextDataDetectorConfig): TextAttribute; @@ -1155,7 +1218,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ bindSelectionMenu(spanType: TextSpanType, content: CustomBuilder, responseType: TextResponseType, options?: SelectionMenuOptions): TextAttribute; @@ -1177,7 +1241,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void): TextAttribute; @@ -1194,7 +1259,8 @@ declare class TextAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature(value: string): TextAttribute; @@ -1206,7 +1272,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ marqueeOptions(options: Optional): TextAttribute; @@ -1218,7 +1285,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onMarqueeStateChange(callback: Callback): TextAttribute; @@ -1230,7 +1298,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ privacySensitive(supported: boolean): TextAttribute; @@ -1242,7 +1311,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ textSelectable(mode: TextSelectableMode): TextAttribute; @@ -1254,7 +1324,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ editMenuOptions(editMenu: EditMenuOptions): TextAttribute; @@ -1266,7 +1337,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading(halfLeading: boolean): TextAttribute; @@ -1278,7 +1350,8 @@ declare class TextAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(isEnabled: boolean): TextAttribute; } @@ -1362,7 +1435,8 @@ declare const Text: TextInterface; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextSpanType { /** @@ -1378,7 +1452,8 @@ declare enum TextSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TEXT = 0, @@ -1395,7 +1470,8 @@ declare enum TextSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1, @@ -1412,7 +1488,8 @@ declare enum TextSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MIXED = 2, @@ -1422,7 +1499,8 @@ declare enum TextSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 3, } @@ -1442,7 +1520,8 @@ declare enum TextSpanType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextResponseType { /** @@ -1458,7 +1537,8 @@ declare enum TextResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT_CLICK = 0, @@ -1475,7 +1555,8 @@ declare enum TextResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LONG_PRESS = 1, @@ -1492,7 +1573,8 @@ declare enum TextResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SELECT = 2, @@ -1502,7 +1584,8 @@ declare enum TextResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 3, } @@ -1514,7 +1597,8 @@ declare enum TextResponseType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MarqueeState { /** @@ -1523,7 +1607,8 @@ declare enum MarqueeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ START = 0, @@ -1533,7 +1618,8 @@ declare enum MarqueeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ BOUNCE = 1, @@ -1543,7 +1629,8 @@ declare enum MarqueeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ FINISH = 2, } @@ -1555,7 +1642,8 @@ declare enum MarqueeState { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MarqueeStartPolicy { /** @@ -1564,7 +1652,8 @@ declare enum MarqueeStartPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -1574,7 +1663,8 @@ declare enum MarqueeStartPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_FOCUS = 1, } @@ -1594,7 +1684,8 @@ declare enum MarqueeStartPolicy { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextOptions { /** @@ -1612,7 +1703,8 @@ declare interface TextOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ controller: TextController; } @@ -1624,7 +1716,8 @@ declare interface TextOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextMarqueeOptions { /** @@ -1634,7 +1727,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ start: boolean; @@ -1645,7 +1739,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ step?: number; @@ -1656,7 +1751,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ loop?: number; @@ -1667,7 +1763,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ fromStart?: boolean; @@ -1678,7 +1775,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ delay?: number; @@ -1689,7 +1787,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ fadeout?: boolean; @@ -1700,7 +1799,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ marqueeStartPolicy?: MarqueeStartPolicy; } @@ -1718,7 +1818,8 @@ declare interface TextMarqueeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextController { /** @@ -1734,7 +1835,8 @@ declare class TextController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ closeSelectionMenu(): void; @@ -1745,7 +1847,8 @@ declare class TextController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setStyledString(value: StyledString): void; @@ -1756,7 +1859,8 @@ declare class TextController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getLayoutManager(): LayoutManager; } diff --git a/api/@internal/component/ets/text_area.d.ts b/api/@internal/component/ets/text_area.d.ts index b0ccd467e1f5fa5525d9baed2ac6ba5c7e8a7bea..46f4e91daa836f7b10421706e5467b9441272cd7 100644 --- a/api/@internal/component/ets/text_area.d.ts +++ b/api/@internal/component/ets/text_area.d.ts @@ -18,6 +18,20 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { KeyboardOptions, PasteEvent } from './richEditor'; +import { CaretStyle, DeleteValue, EditMenuOptions, EditableTextOnChangeCallback, InsertValue, + AutoCapitalizationMode,EditableTextChangeValue,KeyboardAppearance } from './textCommon'; +import { BarState, CopyOptions, FontStyle, FontWeight, LineBreakStrategy, TextContentStyle, TextAlign, TextOverflow, + TextHeightAdaptivePolicy, WordBreak, EllipsisMode } from './enums'; +import { EnterKeyType, SubmitEvent, ContentType } from './textInput'; +import { Dimension, Font, Length, LengthMetrics, ResourceColor, ResourceStr } from './units'; +import { InputCounterOptions, TextContentControllerBase, SelectionOptions, + TextDecorationOptions, CommonMethod, Callback, Optional, Bindable } from './common'; +import { CustomBuilder } from './builder'; +import { Resource } from '../../global/resource'; +/*** endif */ + /** * Provides the method of switching the cursor position. * @@ -39,7 +53,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextAreaController extends TextContentControllerBase { /** @@ -61,7 +76,8 @@ declare class TextAreaController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -87,7 +103,8 @@ declare class TextAreaController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ caretPosition(value: number): void; @@ -119,7 +136,8 @@ declare class TextAreaController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; @@ -136,7 +154,8 @@ declare class TextAreaController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stopEditing(): void; } @@ -163,7 +182,8 @@ declare class TextAreaController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextAreaOptions { /** @@ -188,7 +208,8 @@ declare interface TextAreaOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeholder?: ResourceStr; @@ -218,6 +239,18 @@ declare interface TextAreaOptions { */ text?: ResourceStr; + /** + * Sets the current value of TextArea. + * + * @type { ?(ResourceStr | Bindable) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + text?: ResourceStr | Bindable; + /** * Called when the position of the insertion cursor is set. * @@ -240,7 +273,8 @@ declare interface TextAreaOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ controller?: TextAreaController; } @@ -267,7 +301,8 @@ declare interface TextAreaOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextAreaInterface { /** @@ -295,7 +330,8 @@ interface TextAreaInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: TextAreaOptions): TextAreaAttribute; } @@ -315,7 +351,8 @@ interface TextAreaInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextAreaType { /** @@ -331,7 +368,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 0, @@ -348,7 +386,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER = 2, @@ -365,7 +404,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHONE_NUMBER = 3, @@ -382,7 +422,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMAIL = 5, @@ -392,7 +433,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER_DECIMAL = 12, @@ -402,7 +444,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ URL = 13, } @@ -416,7 +459,8 @@ declare enum TextAreaType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type TextAreaSubmitCallback = (enterKeyType: EnterKeyType, event?: SubmitEvent) => void; @@ -442,7 +486,8 @@ declare type TextAreaSubmitCallback = (enterKeyType: EnterKeyType, event?: Submi * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextAreaAttribute extends CommonMethod { /** @@ -470,7 +515,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeholderColor(value: ResourceColor): TextAreaAttribute; @@ -499,7 +545,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeholderFont(value: Font): TextAreaAttribute; @@ -520,7 +567,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType(value: EnterKeyType): TextAreaAttribute; @@ -549,7 +597,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textAlign(value: TextAlign): TextAreaAttribute; @@ -578,7 +627,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ caretColor(value: ResourceColor): TextAreaAttribute; @@ -607,7 +657,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): TextAreaAttribute; @@ -636,7 +687,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Length): TextAreaAttribute; @@ -665,7 +717,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): TextAreaAttribute; @@ -694,7 +747,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): TextAreaAttribute; @@ -723,7 +777,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: ResourceStr): TextAreaAttribute; @@ -735,7 +790,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textOverflow(value: TextOverflow): TextAreaAttribute; @@ -747,7 +803,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textIndent(value: Dimension): TextAreaAttribute; @@ -779,7 +836,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ inputFilter(value: ResourceStr, error?: (value: string) => void): TextAreaAttribute; @@ -791,7 +849,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ caretStyle(value: CaretStyle): TextAreaAttribute; @@ -803,7 +862,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectedBackgroundColor(value: ResourceColor): TextAreaAttribute; @@ -838,6 +898,18 @@ declare class TextAreaAttribute extends CommonMethod { * @since 14 */ onSubmit(callback: TextAreaSubmitCallback): TextAreaAttribute; + /** + * Called when submitted. + * + * @param { ((enterKey: EnterKeyType) => void) | TextAreaSubmitCallback } callback - callback of the listened event. + * @returns { TextAreaAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onSubmit(callback: ((enterKey: EnterKeyType) => void) | TextAreaSubmitCallback): TextAreaAttribute; /** * Called when the input changes. @@ -874,7 +946,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: EditableTextOnChangeCallback): TextAreaAttribute; @@ -895,7 +968,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onTextSelectionChange(callback: (selectionStart: number, selectionEnd: number) => void): TextAreaAttribute; @@ -916,7 +990,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onContentScroll(callback: (totalOffsetX: number, totalOffsetY: number) => void): TextAreaAttribute; @@ -939,7 +1014,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onEditChange(callback: (isEditing: boolean) => void): TextAreaAttribute; @@ -968,7 +1044,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onCopy(callback: (value: string) => void): TextAreaAttribute; @@ -997,7 +1074,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onCut(callback: (value: string) => void): TextAreaAttribute; @@ -1029,7 +1107,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onPaste(callback: (value: string, event: PasteEvent) => void): TextAreaAttribute; @@ -1058,7 +1137,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ copyOption(value: CopyOptions): TextAreaAttribute; @@ -1079,7 +1159,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableKeyboardOnFocus(value: boolean): TextAreaAttribute; @@ -1099,7 +1180,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxLength(value: number): TextAreaAttribute; @@ -1120,7 +1202,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showCounter(value: boolean, options?: InputCounterOptions): TextAreaAttribute; @@ -1140,7 +1223,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style(value: TextContentStyle): TextAreaAttribute; @@ -1159,7 +1243,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barState(value: BarState): TextAreaAttribute; @@ -1180,7 +1265,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectionMenuHidden(value: boolean): TextAreaAttribute; @@ -1192,7 +1278,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize(value: number | string | Resource): TextAreaAttribute; @@ -1204,7 +1291,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maxFontSize(value: number | string | Resource): TextAreaAttribute; @@ -1215,7 +1303,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: Optional): TextAreaAttribute; @@ -1226,7 +1315,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: Optional): TextAreaAttribute; @@ -1238,7 +1328,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ heightAdaptivePolicy(value: TextHeightAdaptivePolicy): TextAreaAttribute; @@ -1258,7 +1349,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxLines(value: number): TextAreaAttribute; @@ -1270,7 +1362,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak(value: WordBreak): TextAreaAttribute; @@ -1282,7 +1375,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineBreakStrategy(strategy: LineBreakStrategy): TextAreaAttribute; @@ -1313,7 +1407,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customKeyboard(value: CustomBuilder, options?: KeyboardOptions): TextAreaAttribute; @@ -1325,7 +1420,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration(value: TextDecorationOptions): TextAreaAttribute; @@ -1337,7 +1433,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing(value: number | string | Resource): TextAreaAttribute; @@ -1349,7 +1446,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineSpacing(value: LengthMetrics): TextAreaAttribute; @@ -1361,7 +1459,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight(value: number | string | Resource): TextAreaAttribute; @@ -1382,7 +1481,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type(value: TextAreaType): TextAreaAttribute; @@ -1393,7 +1493,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAutoFill(value: boolean): TextAreaAttribute; @@ -1404,7 +1505,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentType(contentType: ContentType): TextAreaAttribute; @@ -1420,7 +1522,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature(value: string): TextAreaAttribute; @@ -1432,7 +1535,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillInsert(callback: Callback): TextAreaAttribute; @@ -1444,7 +1548,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidInsert(callback: Callback): TextAreaAttribute; @@ -1456,7 +1561,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDelete(callback: Callback): TextAreaAttribute; @@ -1468,7 +1574,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDelete(callback: Callback): TextAreaAttribute; @@ -1480,7 +1587,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ editMenuOptions(editMenu: EditMenuOptions): TextAreaAttribute; @@ -1492,7 +1600,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enablePreviewText(enable: boolean): TextAreaAttribute; @@ -1504,7 +1613,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(isEnabled: boolean): TextAreaAttribute; @@ -1516,7 +1626,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ autoCapitalizationMode(mode: AutoCapitalizationMode): TextAreaAttribute; @@ -1528,7 +1639,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading(halfLeading: Optional): TextAreaAttribute; @@ -1540,7 +1652,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ellipsisMode(mode: Optional): TextAreaAttribute; @@ -1551,7 +1664,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } returns the instance of the TextAreaAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ stopBackPress(isStopped: Optional): TextAreaAttribute; @@ -1563,7 +1677,8 @@ declare class TextAreaAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onWillChange(callback: Callback): TextAreaAttribute; @@ -1574,7 +1689,8 @@ declare class TextAreaAttribute extends CommonMethod { * @returns { TextAreaAttribute } returns the instance of the TextAreaAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAppearance(appearance: Optional): TextAreaAttribute; } diff --git a/api/@internal/component/ets/text_clock.d.ts b/api/@internal/component/ets/text_clock.d.ts index f5facc3693689c31be0273f531eca8cf3dfe6f8d..665a27bd9814afdff90a80e4b547a8f984819f49 100644 --- a/api/@internal/component/ets/text_clock.d.ts +++ b/api/@internal/component/ets/text_clock.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonConfiguration, CommonMethod, ShadowOptions, ContentModifier, Optional, DateTimeOptions } from './common' +import { ResourceColor, Length, ResourceStr } from './units' +import { FontStyle, FontWeight } from './enums' +/*** endif */ + /** * Provides a way to control the textclock status. * @@ -38,7 +44,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextClockController { /** @@ -61,7 +68,8 @@ declare class TextClockController { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -87,6 +95,17 @@ declare class TextClockController { * @since 11 */ start(); + /** + * Provides a start event for textclock. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + start(): void; /** * Provides a stop event for textclock. * @@ -110,6 +129,17 @@ declare class TextClockController { * @since 11 */ stop(); + /** + * Provides a stop event for textclock. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + stop(): void; } /** @@ -120,7 +150,8 @@ declare class TextClockController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextClockConfiguration extends CommonConfiguration { /** @@ -132,7 +163,8 @@ declare interface TextClockConfiguration extends CommonConfiguration { /** @@ -371,7 +434,25 @@ declare class TextClockAttribute extends CommonMethod { * @atomicservice * @since 11 */ - format(value: string): TextClockAttribute; + /** + * set display time format,such as "yyyy/mm/dd","yyyy-mm-dd". + * support time format:yyyy,mm,mmm(English month abbreviation),mmmm(Full name of the month in English), + * dd,ddd(English Week abbreviation),dddd(Full name of the week in English), + * HH/hh(24-hour clock/12-hour clock),MM/mm(minute),SS/ss(second). + * The default value is "hh:mm:ss" when TextClock is not in a form. + * The default value is "hh:mm" when TextClock is in a form. + * If the value has second or millisecond, the value will be set to the default value. + * + * @param { ResourceStr } value + * @returns { TextClockAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + format(value: ResourceStr): TextClockAttribute; /** * Provides a date change callback. @@ -416,7 +497,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onDateChange(event: (value: number) => void): TextClockAttribute; @@ -446,7 +528,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): TextClockAttribute; @@ -476,7 +559,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Length): TextClockAttribute; @@ -506,7 +590,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): TextClockAttribute; @@ -536,7 +621,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): TextClockAttribute; @@ -566,7 +652,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: ResourceStr): TextClockAttribute; @@ -589,7 +676,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textShadow(value: ShadowOptions | Array): TextClockAttribute; @@ -618,7 +706,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature(value: string): TextClockAttribute; @@ -630,7 +719,8 @@ declare class TextClockAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): TextClockAttribute; @@ -643,7 +733,8 @@ declare class TextClockAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dateTimeOptions(dateTimeOptions: Optional): TextClockAttribute; } diff --git a/api/@internal/component/ets/text_common.d.ts b/api/@internal/component/ets/text_common.d.ts index edc63a21ea8570a64f8ea729d04c07f643574e50..a48d13b89575c589a5b48fbcf7508b1f84a75b2f 100644 --- a/api/@internal/component/ets/text_common.d.ts +++ b/api/@internal/component/ets/text_common.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor, ResourceStr, Length } from './units'; +import { DecorationStyleInterface, MutableStyledString, StyledString } from './styled_string'; +import { SelectionOptions, Callback } from './common'; +import { TextDecorationType, TextDecorationStyle } from './enums'; +/*** endif */ + /** * Defines the text data detector type. * @@ -31,7 +38,8 @@ * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextDataDetectorType { /** @@ -45,7 +53,8 @@ declare enum TextDataDetectorType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHONE_NUMBER = 0, @@ -60,7 +69,8 @@ declare enum TextDataDetectorType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ URL = 1, @@ -75,7 +85,8 @@ declare enum TextDataDetectorType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMAIL = 2, @@ -90,7 +101,8 @@ declare enum TextDataDetectorType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ADDRESS = 3, @@ -99,7 +111,8 @@ declare enum TextDataDetectorType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TIME = 4, } @@ -117,7 +130,8 @@ declare enum TextDataDetectorType { * @interface TextDataDetectorConfig * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextDataDetectorConfig { /** @@ -133,7 +147,8 @@ declare interface TextDataDetectorConfig { * @type { TextDataDetectorType[] } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ types: TextDataDetectorType[] @@ -153,14 +168,24 @@ declare interface TextDataDetectorConfig { * @since 12 */ onDetectResultUpdate?: (result: string) => void - + /** + * Text data detect result callback. + * + * @type { ?Callback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDetectResultUpdate?: Callback /** * The color of AI entity. * * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor, @@ -170,7 +195,8 @@ declare interface TextDataDetectorConfig { * @type { ?DecorationStyleInterface } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration?: DecorationStyleInterface } @@ -182,7 +208,8 @@ declare interface TextDataDetectorConfig { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextRange { /** @@ -193,7 +220,8 @@ declare interface TextRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: number; @@ -205,7 +233,8 @@ declare interface TextRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end?: number; } @@ -217,7 +246,8 @@ declare interface TextRange { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface InsertValue { /** @@ -227,7 +257,8 @@ declare interface InsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ insertOffset: number; @@ -238,7 +269,8 @@ declare interface InsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ insertValue: string; } @@ -250,7 +282,8 @@ declare interface InsertValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextDeleteDirection { /** @@ -259,7 +292,8 @@ declare enum TextDeleteDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BACKWARD = 0, @@ -269,7 +303,8 @@ declare enum TextDeleteDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FORWARD = 1, } @@ -281,7 +316,8 @@ declare enum TextDeleteDirection { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MenuType { /** @@ -290,7 +326,8 @@ declare enum MenuType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ SELECTION_MENU = 0, @@ -300,7 +337,8 @@ declare enum MenuType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW_MENU = 1, } @@ -312,7 +350,8 @@ declare enum MenuType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum AutoCapitalizationMode { /** @@ -321,7 +360,8 @@ declare enum AutoCapitalizationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -331,7 +371,8 @@ declare enum AutoCapitalizationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ WORDS = 1, @@ -341,7 +382,8 @@ declare enum AutoCapitalizationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ SENTENCES = 2, @@ -351,7 +393,8 @@ declare enum AutoCapitalizationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ ALL_CHARACTERS = 3, } @@ -363,7 +406,8 @@ declare enum AutoCapitalizationMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DeleteValue { /** @@ -373,7 +417,8 @@ declare interface DeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ deleteOffset: number; @@ -384,7 +429,8 @@ declare interface DeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ direction: TextDeleteDirection; @@ -395,7 +441,8 @@ declare interface DeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ deleteValue: string; } @@ -409,7 +456,8 @@ declare interface DeleteValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnDidChangeCallback = (rangeBefore: TextRange, rangeAfter: TextRange) => void; @@ -422,7 +470,8 @@ declare type OnDidChangeCallback = (rangeBefore: TextRange, rangeAfter: TextRang * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Callback when input sometimes has info of previewText. @@ -434,7 +483,8 @@ declare type OnDidChangeCallback = (rangeBefore: TextRange, rangeAfter: TextRang * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare type EditableTextOnChangeCallback = (value: string, previewText?: PreviewText, options?: TextChangeOptions) => void; @@ -445,7 +495,8 @@ declare type EditableTextOnChangeCallback = (value: string, previewText?: Previe * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextBaseController { /** @@ -457,7 +508,8 @@ declare interface TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; @@ -467,7 +519,8 @@ declare interface TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ closeSelectionMenu(): void; @@ -478,7 +531,8 @@ declare interface TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLayoutManager(): LayoutManager; } @@ -491,7 +545,8 @@ declare interface TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextEditControllerEx extends TextBaseController { /** @@ -501,7 +556,8 @@ declare interface TextEditControllerEx extends TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isEditing(): boolean; @@ -511,7 +567,8 @@ declare interface TextEditControllerEx extends TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stopEditing(): void; @@ -523,7 +580,8 @@ declare interface TextEditControllerEx extends TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setCaretOffset(offset: number): boolean; @@ -534,7 +592,8 @@ declare interface TextEditControllerEx extends TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getCaretOffset(): number; @@ -548,6 +607,18 @@ declare interface TextEditControllerEx extends TextBaseController { * @since 12 */ getPreviewText?(): PreviewText; + + /** + * Get PreviewText. + * + * @returns { PreviewText } - Return the PreviewText. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + getPreviewText(): PreviewText; } /** @@ -556,7 +627,8 @@ declare interface TextEditControllerEx extends TextBaseController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PreviewText { /** @@ -566,7 +638,8 @@ declare interface PreviewText { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; @@ -577,7 +650,8 @@ declare interface PreviewText { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ value: string; } @@ -589,7 +663,8 @@ declare interface PreviewText { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface StyledStringController { /** @@ -599,7 +674,8 @@ declare interface StyledStringController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setStyledString(styledString: StyledString): void; @@ -610,7 +686,8 @@ declare interface StyledStringController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getStyledString(): MutableStyledString; } @@ -622,7 +699,8 @@ declare interface StyledStringController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface StyledStringChangedListener { /** @@ -632,7 +710,8 @@ declare interface StyledStringChangedListener { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillChange?: Callback; @@ -643,7 +722,8 @@ declare interface StyledStringChangedListener { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidChange?: OnDidChangeCallback; } @@ -655,7 +735,8 @@ declare interface StyledStringChangedListener { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface StyledStringChangeValue { /** @@ -665,7 +746,8 @@ interface StyledStringChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ range: TextRange; @@ -676,7 +758,8 @@ interface StyledStringChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ replacementString: StyledString; @@ -687,7 +770,8 @@ interface StyledStringChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ previewText?: StyledString; } @@ -699,7 +783,8 @@ interface StyledStringChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LayoutManager { /** @@ -709,7 +794,8 @@ declare interface LayoutManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLineCount(): number; @@ -722,7 +808,8 @@ declare interface LayoutManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getGlyphPositionAtCoordinate(x: number, y: number): PositionWithAffinity; @@ -759,7 +846,8 @@ declare interface LayoutManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PositionWithAffinity { /** @@ -769,7 +857,8 @@ interface PositionWithAffinity { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position: number; @@ -855,7 +944,8 @@ declare type TextBox = import('../api/@ohos.graphics.text').default.TextBox; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CaretStyle { /** @@ -873,7 +963,8 @@ interface CaretStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Length, @@ -892,7 +983,8 @@ interface CaretStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor, } @@ -903,7 +995,8 @@ interface CaretStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextMenuItemId { /** @@ -915,7 +1008,8 @@ declare class TextMenuItemId { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static of(id: ResourceStr): TextMenuItemId; @@ -927,7 +1021,8 @@ declare class TextMenuItemId { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ equals(id: TextMenuItemId): boolean; @@ -939,7 +1034,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly CUT: TextMenuItemId; @@ -951,7 +1047,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly COPY: TextMenuItemId; @@ -963,7 +1060,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly PASTE: TextMenuItemId; @@ -975,7 +1073,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly SELECT_ALL: TextMenuItemId; @@ -987,7 +1086,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly COLLABORATION_SERVICE: TextMenuItemId; @@ -999,7 +1099,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly CAMERA_INPUT: TextMenuItemId; @@ -1011,7 +1112,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly AI_WRITER: TextMenuItemId; @@ -1023,7 +1125,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly TRANSLATE: TextMenuItemId; @@ -1035,7 +1138,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly SEARCH: TextMenuItemId; @@ -1047,7 +1151,8 @@ declare class TextMenuItemId { * @static * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ static readonly SHARE: TextMenuItemId; } @@ -1059,7 +1164,8 @@ declare class TextMenuItemId { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextMenuItem { /** @@ -1069,7 +1175,8 @@ declare interface TextMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ content: ResourceStr; /** @@ -1079,7 +1186,8 @@ declare interface TextMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ icon?: ResourceStr; /** @@ -1089,7 +1197,8 @@ declare interface TextMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: TextMenuItemId; /** @@ -1099,11 +1208,41 @@ declare interface TextMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ labelInfo?: ResourceStr; } +/** + * Callback function when the selection menu create. + * + * @typedef { function } OnCreateMenuCallback + * @param { Array } menuItems - currently displayed menu items. + * @returns { Array } Return the menu items will displayed after operations. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +type OnCreateMenuCallback = (menuItems: Array) => Array; + +/** + * Invoke upon clicking an item, capable of intercepting the default system menu execution behavior. + * + * @typedef { function } OnMenuItemClickCallback + * @param { TextMenuItem } menuItem - current default menu. + * @param { TextRange } range - current selected range. + * @returns { boolean } - Return True, the event is consumed, false otherwise. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +type OnMenuItemClickCallback = (menuItem: TextMenuItem, range: TextRange) => boolean + /** * EditMenuOptions * @@ -1111,7 +1250,8 @@ declare interface TextMenuItem { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface EditMenuOptions { /** @@ -1137,6 +1277,30 @@ declare interface EditMenuOptions { * @since 12 */ onMenuItemClick(menuItem: TextMenuItem, range: TextRange): boolean; + + /** + * Passes the default menu, invokes before every display to generate a menu for triggering click events. + * + * @type { OnCreateMenuCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onCreateMenu: OnCreateMenuCallback; + + /** + * Invoke upon clicking an item, capable of intercepting the default system menu execution behavior. + * + * @type { OnMenuItemClickCallback } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onMenuItemClick: OnMenuItemClickCallback; } /** @@ -1146,7 +1310,8 @@ declare interface EditMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface DecorationStyleResult { /** @@ -1156,7 +1321,8 @@ interface DecorationStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: TextDecorationType; @@ -1167,7 +1333,8 @@ interface DecorationStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color: ResourceColor; @@ -1178,7 +1345,8 @@ interface DecorationStyleResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: TextDecorationStyle; } @@ -1191,7 +1359,8 @@ interface DecorationStyleResult { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FontSettingOptions { /** @@ -1202,7 +1371,8 @@ declare interface FontSettingOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableVariableFontWeight?: boolean; } @@ -1213,7 +1383,8 @@ declare interface FontSettingOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextChangeOptions { /** @@ -1223,7 +1394,8 @@ declare interface TextChangeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ rangeBefore: TextRange; @@ -1234,7 +1406,8 @@ declare interface TextChangeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ rangeAfter: TextRange; @@ -1245,7 +1418,8 @@ declare interface TextChangeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ oldContent: string; @@ -1256,7 +1430,8 @@ declare interface TextChangeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ oldPreviewText: PreviewText; } @@ -1268,7 +1443,8 @@ declare interface TextChangeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface EditableTextChangeValue { /** @@ -1278,7 +1454,8 @@ interface EditableTextChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ content: string; @@ -1289,7 +1466,8 @@ interface EditableTextChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ previewText?: PreviewText; @@ -1300,7 +1478,8 @@ interface EditableTextChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ options?: TextChangeOptions; } @@ -1312,7 +1491,8 @@ interface EditableTextChangeValue { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextMenuShowMode { /** @@ -1321,7 +1501,8 @@ declare enum TextMenuShowMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -1332,7 +1513,8 @@ declare enum TextMenuShowMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ PREFER_WINDOW = 1, } @@ -1344,7 +1526,8 @@ declare enum TextMenuShowMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextMenuOptions { /** @@ -1354,7 +1537,8 @@ declare interface TextMenuOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ showMode?: TextMenuShowMode; } @@ -1364,7 +1548,8 @@ declare interface TextMenuOptions { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum KeyboardAppearance { /** @@ -1372,7 +1557,8 @@ declare enum KeyboardAppearance { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ NONE_IMMERSIVE = 0, @@ -1381,7 +1567,8 @@ declare enum KeyboardAppearance { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ IMMERSIVE = 1, @@ -1390,7 +1577,8 @@ declare enum KeyboardAppearance { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHT_IMMERSIVE = 2, @@ -1399,7 +1587,8 @@ declare enum KeyboardAppearance { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DARK_IMMERSIVE = 3, } \ No newline at end of file diff --git a/api/@internal/component/ets/text_input.d.ts b/api/@internal/component/ets/text_input.d.ts index 4eb36d3bcc9629ca28f52bb5a226c0f6c55837b4..dcb7b0be002a2729671e65888edcfafb1bf4c9db 100644 --- a/api/@internal/component/ets/text_input.d.ts +++ b/api/@internal/component/ets/text_input.d.ts @@ -18,6 +18,18 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CancelButtonSymbolOptions, CancelButtonOptions } from "./search"; +import { Callback, CommonMethod, TextContentControllerBase, SelectionOptions, InputCounterOptions, TextDecorationOptions, Optional, Bindable} from "./common"; +import { CustomBuilder } from './builder'; +import { BarState, LineBreakStrategy, TextAlign, FontStyle, FontWeight, WordBreak, TextOverflow, + CopyOptions, TextHeightAdaptivePolicy, TextContentStyle, EllipsisMode } from './enums'; +import { Resource, ResourceStr, ResourceColor, Dimension, Font, Length } from './units'; +import { InsertValue, DeleteValue, CaretStyle, EditableTextOnChangeCallback, EditMenuOptions, + AutoCapitalizationMode,EditableTextChangeValue,KeyboardAppearance } from "./textCommon"; +import { KeyboardOptions, PasteEvent } from "./richEditor"; +/*** endif */ + /** * Declare the type of input box * @@ -40,7 +52,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum InputType { /** @@ -62,7 +75,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Normal, @@ -85,7 +99,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Number, @@ -108,7 +123,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PhoneNumber, @@ -131,7 +147,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Email, @@ -154,7 +171,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Password, @@ -171,7 +189,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER_PASSWORD = 8, @@ -180,7 +199,8 @@ declare enum InputType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_LOCK_PASSWORD = 9, @@ -195,7 +215,8 @@ declare enum InputType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USER_NAME = 10, @@ -210,7 +231,8 @@ declare enum InputType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NEW_PASSWORD = 11, @@ -220,7 +242,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER_DECIMAL = 12, @@ -230,7 +253,8 @@ declare enum InputType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ URL = 13, } @@ -241,7 +265,8 @@ declare enum InputType { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ContentType { /** @@ -249,7 +274,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USER_NAME = 0, @@ -258,7 +284,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PASSWORD = 1, @@ -267,7 +294,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NEW_PASSWORD = 2, @@ -276,7 +304,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FULL_STREET_ADDRESS = 3, @@ -285,7 +314,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HOUSE_NUMBER = 4, @@ -294,7 +324,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISTRICT_ADDRESS = 5, @@ -303,7 +334,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CITY_ADDRESS = 6, @@ -312,7 +344,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PROVINCE_ADDRESS = 7, @@ -321,7 +354,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COUNTRY_ADDRESS = 8, @@ -330,7 +364,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERSON_FULL_NAME = 9, @@ -339,7 +374,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERSON_LAST_NAME = 10, @@ -348,7 +384,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERSON_FIRST_NAME = 11, @@ -357,7 +394,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHONE_NUMBER = 12, @@ -366,7 +404,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHONE_COUNTRY_CODE = 13, @@ -375,7 +414,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FULL_PHONE_NUMBER = 14, @@ -384,7 +424,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EMAIL_ADDRESS = 15, @@ -393,7 +434,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BANK_CARD_NUMBER = 16, @@ -402,7 +444,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ID_CARD_NUMBER = 17, @@ -411,7 +454,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NICKNAME = 23, @@ -420,7 +464,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DETAIL_INFO_WITHOUT_STREET = 24, @@ -429,7 +474,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FORMAT_ADDRESS = 25, @@ -438,7 +484,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ PASSPORT_NUMBER = 26, @@ -447,7 +494,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ VALIDITY = 27, @@ -456,7 +504,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ISSUE_AT = 28, @@ -465,7 +514,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ORGANIZATION = 29, @@ -474,7 +524,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TAX_ID = 30, @@ -483,7 +534,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ADDRESS_CITY_AND_STATE = 31, @@ -492,7 +544,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ FLIGHT_NUMBER = 32, @@ -501,7 +554,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LICENSE_NUMBER = 33, @@ -510,7 +564,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LICENSE_FILE_NUMBER = 34, @@ -519,7 +574,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LICENSE_PLATE = 35, @@ -528,7 +584,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENGINE_NUMBER = 36, @@ -537,7 +594,8 @@ declare enum ContentType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ LICENSE_CHASSIS_NUMBER = 37 } @@ -564,7 +622,8 @@ declare enum ContentType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum EnterKeyType { /** @@ -586,7 +645,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Go = 2, @@ -609,7 +669,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Search = 3, @@ -632,7 +693,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Send = 4, @@ -655,7 +717,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Next = 5, @@ -678,7 +741,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Done = 6, @@ -695,7 +759,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIOUS = 7, @@ -712,7 +777,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NEW_LINE = 8, } @@ -724,7 +790,8 @@ declare enum EnterKeyType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface UnderlineColor { /** @@ -734,7 +801,8 @@ declare interface UnderlineColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ typing?: ResourceColor | undefined; /** @@ -744,7 +812,8 @@ declare interface UnderlineColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ normal?: ResourceColor | undefined; /** @@ -754,7 +823,8 @@ declare interface UnderlineColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ error?: ResourceColor | undefined; /** @@ -764,7 +834,8 @@ declare interface UnderlineColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ disable?: ResourceColor | undefined; } @@ -776,7 +847,8 @@ declare interface UnderlineColor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SubmitEvent { /** @@ -785,7 +857,8 @@ declare interface SubmitEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ keepEditableState(): void; @@ -796,7 +869,8 @@ declare interface SubmitEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ text: string; } @@ -822,7 +896,8 @@ declare interface SubmitEvent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextInputController extends TextContentControllerBase { /** @@ -844,7 +919,8 @@ declare class TextInputController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -870,7 +946,8 @@ declare class TextInputController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ caretPosition(value: number): void; @@ -902,7 +979,8 @@ declare class TextInputController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setTextSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void; @@ -919,7 +997,8 @@ declare class TextInputController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stopEditing(): void; } @@ -946,7 +1025,8 @@ declare class TextInputController extends TextContentControllerBase { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextInputOptions { /** @@ -971,7 +1051,8 @@ declare interface TextInputOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeholder?: ResourceStr; @@ -1001,6 +1082,18 @@ declare interface TextInputOptions { */ text?: ResourceStr; + /** + * Sets the current value of TextInput. + * + * @type { ?(ResourceStr | Bindable) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + text?: ResourceStr | Bindable; + /** * Called when the position of the insertion cursor is set. * @@ -1023,7 +1116,8 @@ declare interface TextInputOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ controller?: TextInputController; } @@ -1050,7 +1144,8 @@ declare interface TextInputOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TextInputStyle { /** @@ -1072,7 +1167,8 @@ declare enum TextInputStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Default, @@ -1095,7 +1191,8 @@ declare enum TextInputStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Inline } @@ -1122,7 +1219,8 @@ declare enum TextInputStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextInputInterface { /** @@ -1150,7 +1248,8 @@ interface TextInputInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value?: TextInputOptions): TextInputAttribute; } @@ -1169,7 +1268,8 @@ interface TextInputInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PasswordIcon { /** @@ -1186,7 +1286,8 @@ interface PasswordIcon { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onIconSrc?: string | Resource; @@ -1204,7 +1305,8 @@ interface PasswordIcon { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offIconSrc?: string | Resource; } @@ -1218,7 +1320,8 @@ interface PasswordIcon { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnSubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => void; @@ -1231,7 +1334,8 @@ declare type OnSubmitCallback = (enterKey: EnterKeyType, event: SubmitEvent) => * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTextSelectionChangeCallback = (selectionStart: number, selectionEnd: number) => void; @@ -1244,11 +1348,11 @@ declare type OnTextSelectionChangeCallback = (selectionStart: number, selectionE * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnContentScrollCallback = (totalOffsetX: number, totalOffsetY: number) => void; - /** * Defines a TextInput callback when onPaste. * @@ -1258,7 +1362,8 @@ declare type OnContentScrollCallback = (totalOffsetX: number, totalOffsetY: numb * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnPasteCallback = (content: string, event: PasteEvent) => void; @@ -1284,7 +1389,8 @@ declare type OnPasteCallback = (content: string, event: PasteEvent) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextInputAttribute extends CommonMethod { /** @@ -1312,7 +1418,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type(value: InputType): TextInputAttribute; @@ -1323,7 +1430,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentType(value: ContentType): TextInputAttribute; @@ -1352,7 +1460,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeholderColor(value: ResourceColor): TextInputAttribute; @@ -1364,7 +1473,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textOverflow(value: TextOverflow): TextInputAttribute; @@ -1376,7 +1486,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textIndent(value: Dimension): TextInputAttribute; @@ -1405,7 +1516,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeholderFont(value?: Font): TextInputAttribute; @@ -1434,7 +1546,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType(value: EnterKeyType): TextInputAttribute; @@ -1463,7 +1576,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ caretColor(value: ResourceColor): TextInputAttribute; @@ -1514,7 +1628,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onEditChange(callback: Callback): TextInputAttribute; @@ -1553,7 +1668,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onSubmit(callback: OnSubmitCallback): TextInputAttribute; @@ -1592,7 +1708,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: EditableTextOnChangeCallback): TextInputAttribute; @@ -1623,7 +1740,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onTextSelectionChange(callback: OnTextSelectionChangeCallback): TextInputAttribute; @@ -1654,7 +1772,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onContentScroll(callback: OnContentScrollCallback): TextInputAttribute; @@ -1683,7 +1802,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxLength(value: number): TextInputAttribute; @@ -1712,7 +1832,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): TextInputAttribute; @@ -1741,7 +1862,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Length): TextInputAttribute; @@ -1770,7 +1892,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): TextInputAttribute; @@ -1799,7 +1922,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight(value: number | FontWeight | string): TextInputAttribute; @@ -1828,7 +1952,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: ResourceStr): TextInputAttribute; @@ -1871,7 +1996,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ inputFilter(value: ResourceStr, error?: Callback): TextInputAttribute; @@ -1910,7 +2036,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onCopy(callback: Callback): TextInputAttribute; @@ -1949,7 +2076,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onCut(callback: Callback): TextInputAttribute; @@ -1991,7 +2119,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onPaste(callback: OnPasteCallback): TextInputAttribute; @@ -2020,7 +2149,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ copyOption(value: CopyOptions): TextInputAttribute; @@ -2049,7 +2179,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showPasswordIcon(value: boolean): TextInputAttribute; @@ -2078,7 +2209,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textAlign(value: TextAlign): TextInputAttribute; @@ -2107,7 +2239,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style(value: TextInputStyle | TextContentStyle): TextInputAttribute; @@ -2128,7 +2261,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ caretStyle(value: CaretStyle): TextInputAttribute; @@ -2149,7 +2283,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedBackgroundColor(value: ResourceColor): TextInputAttribute; @@ -2170,7 +2305,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ caretPosition(value: number): TextInputAttribute; @@ -2191,7 +2327,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enableKeyboardOnFocus(value: boolean): TextInputAttribute; @@ -2211,7 +2348,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ passwordIcon(value: PasswordIcon): TextInputAttribute; @@ -2241,7 +2379,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showError(value?: ResourceStr | undefined): TextInputAttribute; @@ -2261,7 +2400,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showUnit(value: CustomBuilder): TextInputAttribute; @@ -2281,7 +2421,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showUnderline(value: boolean): TextInputAttribute; @@ -2293,7 +2434,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ underlineColor(value: ResourceColor | UnderlineColor | undefined): TextInputAttribute; @@ -2314,7 +2456,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectionMenuHidden(value: boolean): TextInputAttribute; @@ -2333,7 +2476,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ barState(value: BarState): TextInputAttribute; @@ -2353,7 +2497,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxLines(value: number): TextInputAttribute; @@ -2365,7 +2510,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak(value: WordBreak): TextInputAttribute; @@ -2377,7 +2523,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineBreakStrategy(strategy: LineBreakStrategy): TextInputAttribute; @@ -2409,7 +2556,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customKeyboard(value: CustomBuilder, options?: KeyboardOptions): TextInputAttribute; @@ -2422,7 +2570,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ showCounter(value: boolean, options?: InputCounterOptions): TextInputAttribute; @@ -2468,6 +2617,19 @@ declare class TextInputAttribute extends CommonMethod { */ cancelButton(symbolOptions: CancelButtonSymbolOptions): TextInputAttribute; + /** + * Set the cancel button style + * + * @param { CancelButtonOptions | CancelButtonSymbolOptions } symbolOptions - indicates the style of the cancel button. + * @returns { TextInputAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + cancelButton(symbolOptions: CancelButtonOptions | CancelButtonSymbolOptions): TextInputAttribute; + /** * Sets selection when on focus. * @@ -2485,7 +2647,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ selectAll(value: boolean): TextInputAttribute; @@ -2497,7 +2660,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize(value: number | string | Resource): TextInputAttribute; @@ -2509,7 +2673,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maxFontSize(value: number | string | Resource): TextInputAttribute; @@ -2520,7 +2685,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ minFontScale(scale: Optional): TextInputAttribute; @@ -2531,7 +2697,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ maxFontScale(scale: Optional): TextInputAttribute; @@ -2543,7 +2710,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ heightAdaptivePolicy(value: TextHeightAdaptivePolicy): TextInputAttribute; @@ -2562,7 +2730,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAutoFill(value: boolean): TextInputAttribute; @@ -2574,7 +2743,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration(value: TextDecorationOptions): TextInputAttribute; @@ -2586,7 +2756,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing(value: number | string | Resource): TextInputAttribute; @@ -2598,7 +2769,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight(value: number | string | Resource): TextInputAttribute; @@ -2617,7 +2789,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } Returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ passwordRules(value: string): TextInputAttribute; @@ -2633,7 +2806,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFeature(value: string): TextInputAttribute; @@ -2645,7 +2819,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showPassword(visible: boolean): TextInputAttribute; @@ -2657,7 +2832,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSecurityStateChange(callback: Callback): TextInputAttribute; @@ -2669,7 +2845,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillInsert(callback: Callback): TextInputAttribute; @@ -2681,7 +2858,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidInsert(callback: Callback): TextInputAttribute; @@ -2693,7 +2871,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDelete(callback: Callback): TextInputAttribute; @@ -2705,7 +2884,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDelete(callback: Callback): TextInputAttribute; @@ -2717,7 +2897,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ editMenuOptions(editMenu: EditMenuOptions): TextInputAttribute; @@ -2729,7 +2910,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enablePreviewText(enable: boolean): TextInputAttribute; @@ -2741,7 +2923,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(isEnabled: boolean): TextInputAttribute; @@ -2753,7 +2936,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 20 + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 */ autoCapitalizationMode(mode: AutoCapitalizationMode): TextInputAttribute; @@ -2765,7 +2949,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading(halfLeading: Optional): TextInputAttribute; @@ -2777,7 +2962,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ellipsisMode(mode: Optional): TextInputAttribute; @@ -2788,7 +2974,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ stopBackPress(isStopped: Optional): TextInputAttribute; @@ -2800,7 +2987,8 @@ declare class TextInputAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onWillChange(callback: Callback): TextInputAttribute; @@ -2811,7 +2999,8 @@ declare class TextInputAttribute extends CommonMethod { * @returns { TextInputAttribute } returns the instance of the TextInputAttribute. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAppearance(appearance: Optional): TextInputAttribute; diff --git a/api/@internal/component/ets/text_picker.d.ts b/api/@internal/component/ets/text_picker.d.ts index 2d3b976c8b54296a0067ad8d057c7674227d021f..694743e1678ea28ba38af3b9cc62895a5aba2978 100644 --- a/api/@internal/component/ets/text_picker.d.ts +++ b/api/@internal/component/ets/text_picker.d.ts @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource, ResourceColor, Offset, Dimension, ResourceStr } from './units'; +import { CommonMethod, PickerTextStyle, PickerDialogButtonStyle, Rectangle, BlurStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, BackgroundBlurStyleOptions, BackgroundEffectOptions, Optional, Callback } from './common'; +import { DialogAlignment } from './alertDialog'; +import { CrownSensitivity, TextOverflow } from './enums'; +import { LengthMetrics } from './../Graphics'; +/*** endif */ + /** * Define the contents of each selector item. * @@ -33,7 +41,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextPickerRangeContent { /** @@ -51,7 +60,8 @@ declare interface TextPickerRangeContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ icon: string | Resource; @@ -70,7 +80,8 @@ declare interface TextPickerRangeContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ text?: string | Resource; } @@ -89,7 +100,8 @@ declare interface TextPickerRangeContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextCascadePickerRangeContent { /** @@ -106,7 +118,8 @@ declare interface TextCascadePickerRangeContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ text: string | Resource; @@ -124,7 +137,8 @@ declare interface TextCascadePickerRangeContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ children?: TextCascadePickerRangeContent[]; } @@ -151,7 +165,8 @@ declare interface TextCascadePickerRangeContent { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextPickerOptions { /** @@ -178,7 +193,8 @@ declare interface TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ range: string[] | string[][] | Resource | TextPickerRangeContent[] | TextCascadePickerRangeContent[]; @@ -208,7 +224,18 @@ declare interface TextPickerOptions { * @atomicservice * @since 11 */ - value?: string | string[]; + /** + * Value of the current selection. + * Only valid when only text is displayed. + * + * @type { ?(ResourceStr | ResourceStr[]) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + value?: ResourceStr | ResourceStr[]; /** * Current selected subscript. @@ -232,7 +259,8 @@ declare interface TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selected?: number | number[]; @@ -243,7 +271,8 @@ declare interface TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ columnWidths?: LengthMetrics[]; } @@ -270,7 +299,8 @@ declare interface TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextPickerInterface { /** @@ -298,7 +328,8 @@ interface TextPickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: TextPickerOptions): TextPickerAttribute; } @@ -310,7 +341,8 @@ interface TextPickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DividerOptions { /** @@ -320,7 +352,8 @@ declare interface DividerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: Dimension; @@ -331,7 +364,8 @@ declare interface DividerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -342,7 +376,8 @@ declare interface DividerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ startMargin?: Dimension; @@ -353,7 +388,8 @@ declare interface DividerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ endMargin?: Dimension; } @@ -366,7 +402,8 @@ declare interface DividerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextPickerTextStyle extends PickerTextStyle { /** @@ -376,7 +413,8 @@ declare interface TextPickerTextStyle extends PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize?: number | string | Resource; @@ -387,7 +425,8 @@ declare interface TextPickerTextStyle extends PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ maxFontSize?: number | string | Resource; @@ -398,7 +437,8 @@ declare interface TextPickerTextStyle extends PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ overflow?: TextOverflow; } @@ -412,7 +452,8 @@ declare interface TextPickerTextStyle extends PickerTextStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare type TextPickerScrollStopCallback = (value: string | string[], index: number | number[]) => void; @@ -425,7 +466,8 @@ declare type TextPickerScrollStopCallback = (value: string | string[], index: nu * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTextPickerChangeCallback = (selectItem: string | string[], index: number | number[]) => void; @@ -438,7 +480,8 @@ declare type OnTextPickerChangeCallback = (selectItem: string | string[], index: * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type TextPickerEnterSelectedAreaCallback = (value: string | string[], index: number | number[]) => void; @@ -464,7 +507,8 @@ declare type TextPickerEnterSelectedAreaCallback = (value: string | string[], in * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextPickerAttribute extends CommonMethod { /** @@ -492,7 +536,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ defaultPickerItemHeight(value: number | string): TextPickerAttribute; @@ -504,7 +549,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ defaultPickerItemHeight(height: Optional): TextPickerAttribute; @@ -524,7 +570,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ canLoop(value: boolean): TextPickerAttribute; @@ -536,7 +583,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ canLoop(isLoop: Optional): TextPickerAttribute; @@ -557,7 +605,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle(value: PickerTextStyle): TextPickerAttribute; @@ -569,7 +618,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle(style: Optional): TextPickerAttribute; @@ -590,7 +640,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle(value: PickerTextStyle): TextPickerAttribute; @@ -602,7 +653,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle(style: Optional): TextPickerAttribute; @@ -623,7 +675,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle(value: PickerTextStyle): TextPickerAttribute; @@ -635,7 +688,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle(style: Optional): TextPickerAttribute; @@ -647,7 +701,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ disableTextStyleAnimation(disabled: boolean): TextPickerAttribute; @@ -659,7 +714,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ defaultTextStyle(style: TextPickerTextStyle): TextPickerAttribute; @@ -725,7 +781,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Optional): TextPickerAttribute; @@ -738,7 +795,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStop(callback: TextPickerScrollStopCallback): TextPickerAttribute; @@ -751,7 +809,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStop(callback: Optional): TextPickerAttribute; @@ -764,7 +823,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onEnterSelectedArea(callback: TextPickerEnterSelectedAreaCallback): TextPickerAttribute; @@ -787,7 +847,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedIndex(value: number | number[]): TextPickerAttribute; @@ -800,7 +861,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedIndex(index: Optional): TextPickerAttribute; @@ -812,7 +874,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ divider(value: DividerOptions | null): TextPickerAttribute; @@ -824,7 +887,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ divider(textDivider: Optional): TextPickerAttribute; @@ -836,7 +900,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ gradientHeight(value: Dimension): TextPickerAttribute; @@ -847,7 +912,8 @@ declare class TextPickerAttribute extends CommonMethod { * @returns { TextPickerAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(enable: Optional): TextPickerAttribute; @@ -859,7 +925,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ gradientHeight(height: Optional): TextPickerAttribute; @@ -871,7 +938,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ digitalCrownSensitivity(sensitivity: Optional): TextPickerAttribute; } @@ -898,7 +966,8 @@ declare class TextPickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextPickerResult { /** @@ -925,7 +994,8 @@ declare interface TextPickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ value: string | string[]; @@ -951,7 +1021,8 @@ declare interface TextPickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ index: number | number[]; } @@ -981,7 +1052,8 @@ declare interface TextPickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextPickerDialogOptions extends TextPickerOptions { /** @@ -1006,7 +1078,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ defaultPickerItemHeight?: number | string; @@ -1026,7 +1099,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ canLoop?: boolean; @@ -1045,7 +1119,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle?: PickerTextStyle; @@ -1064,7 +1139,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle?: PickerTextStyle; @@ -1075,7 +1151,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ acceptButtonStyle?: PickerDialogButtonStyle; @@ -1086,7 +1163,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cancelButtonStyle?: PickerDialogButtonStyle; @@ -1105,7 +1183,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle?: PickerTextStyle; @@ -1116,7 +1195,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ disableTextStyleAnimation?: boolean; @@ -1127,7 +1207,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ defaultTextStyle?: TextPickerTextStyle; @@ -1153,7 +1234,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAccept?: (value: TextPickerResult) => void; @@ -1179,7 +1261,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onCancel?: () => void; @@ -1205,7 +1288,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onChange?: (value: TextPickerResult) => void; @@ -1216,7 +1300,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ onScrollStop?: Callback; @@ -1227,7 +1312,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onEnterSelectedArea?: Callback; @@ -1246,7 +1332,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskRect?: Rectangle; @@ -1265,7 +1352,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: DialogAlignment; @@ -1284,7 +1372,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Offset; @@ -1305,7 +1394,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -1326,7 +1416,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -1337,7 +1428,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -1348,7 +1440,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -1359,7 +1452,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: () => void; @@ -1370,7 +1464,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: () => void; @@ -1381,7 +1476,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: () => void; @@ -1392,7 +1488,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: () => void; @@ -1403,7 +1500,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -1415,7 +1513,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -1427,7 +1526,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -1438,7 +1538,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback?: boolean; } @@ -1462,7 +1563,8 @@ declare interface TextPickerDialogOptions extends TextPickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextPickerDialog { /** diff --git a/api/@internal/component/ets/text_timer.d.ts b/api/@internal/component/ets/text_timer.d.ts index 4f3c4f5dbbd74df4bff0b965d4d2d44b282195e6..a2ce028f11ed14ae1117909559e1181d63d779b5 100644 --- a/api/@internal/component/ets/text_timer.d.ts +++ b/api/@internal/component/ets/text_timer.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CommonConfiguration,CommonMethod,ShadowOptions,ContentModifier } from './common' +import { ResourceColor,Length,ResourceStr } from './units' +import { FontStyle,FontWeight } from './enums' +/*** endif */ + /** * Provides a way to control the process. * @@ -38,7 +44,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TextTimerController { /** @@ -62,7 +69,8 @@ declare class TextTimerController { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -91,6 +99,18 @@ declare class TextTimerController { */ start(); + /** + * Provides a start event for timer. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + start():void; + /** * Provides a pause event for timer. * @@ -116,6 +136,18 @@ declare class TextTimerController { */ pause(); + /** + * Provides a pause event for timer. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pause():void; + /** * Provides an event to reset timer. * @@ -140,6 +172,18 @@ declare class TextTimerController { * @since 11 */ reset(); + + /** + * Provides an event to reset timer. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + reset():void; } /** @@ -150,7 +194,8 @@ declare class TextTimerController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TextTimerConfiguration extends CommonConfiguration { /** @@ -162,7 +207,8 @@ declare interface TextTimerConfiguration extends CommonConfiguration { /** @@ -434,7 +490,8 @@ declare class TextTimerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ format(value: string): TextTimerAttribute; @@ -465,7 +522,8 @@ declare class TextTimerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontColor(value: ResourceColor): TextTimerAttribute; @@ -496,7 +554,8 @@ declare class TextTimerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize(value: Length): TextTimerAttribute; @@ -527,7 +586,8 @@ declare class TextTimerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle(value: FontStyle): TextTimerAttribute; @@ -560,7 +620,19 @@ declare class TextTimerAttribute extends CommonMethod { * @atomicservice * @since 11 */ - fontWeight(value: number | FontWeight | string): TextTimerAttribute; + /** + * Called when the fontWeight is set + * + * @param { number | FontWeight | ResourceStr } value + * @returns { TextTimerAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + fontWeight(value: number | FontWeight | ResourceStr): TextTimerAttribute; /** * Called when the fontFamily is set @@ -589,7 +661,8 @@ declare class TextTimerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily(value: ResourceStr): TextTimerAttribute; @@ -620,7 +693,8 @@ declare class TextTimerAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onTimer(event: (utc: number, elapsedTime: number) => void): TextTimerAttribute; @@ -641,7 +715,8 @@ declare class TextTimerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textShadow(value: ShadowOptions | Array): TextTimerAttribute; @@ -653,7 +728,8 @@ declare class TextTimerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): TextTimerAttribute; } diff --git a/api/@internal/component/ets/time_picker.d.ts b/api/@internal/component/ets/time_picker.d.ts index 535ad84ead136849f576c276ee017acb9e64457f..bf39d113a52256de4bd250d8921a87aebcfba55c 100644 --- a/api/@internal/component/ets/time_picker.d.ts +++ b/api/@internal/component/ets/time_picker.d.ts @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ResourceColor, Offset } from './units'; +import { CommonMethod, PickerTextStyle, PickerDialogButtonStyle, Rectangle, BlurStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, + BackgroundBlurStyleOptions, BackgroundEffectOptions, Optional, Callback, DateTimeOptions } from './common'; +import { DialogAlignment } from './alertDialog'; +import { CrownSensitivity } from './enums'; +/*** endif */ + /** * Defines the struct of TimePickerResult. * @@ -40,7 +48,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TimePickerResult { /** @@ -65,7 +74,8 @@ declare interface TimePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hour: number; @@ -91,7 +101,8 @@ declare interface TimePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ minute: number; @@ -102,7 +113,8 @@ declare interface TimePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ second: number; } @@ -120,7 +132,8 @@ declare interface TimePickerResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum TimePickerFormat { /** @@ -134,9 +147,10 @@ declare enum TimePickerFormat { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - HOUR_MINUTE, + HOUR_MINUTE = 0, /** * Hour and minute and second @@ -149,9 +163,10 @@ declare enum TimePickerFormat { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - HOUR_MINUTE_SECOND, + HOUR_MINUTE_SECOND = 1, } /** @@ -176,7 +191,8 @@ declare enum TimePickerFormat { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TimePickerOptions { /** @@ -201,7 +217,8 @@ declare interface TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selected?: Date; @@ -222,7 +239,8 @@ declare interface TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ format?: TimePickerFormat; @@ -233,7 +251,8 @@ declare interface TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ start?: Date; @@ -244,7 +263,8 @@ declare interface TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ end?: Date; } @@ -271,7 +291,8 @@ declare interface TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TimePickerInterface { /** @@ -299,7 +320,8 @@ interface TimePickerInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: TimePickerOptions): TimePickerAttribute; } @@ -321,7 +343,8 @@ declare type DateTimeOptions = import('../api/@ohos.intl').default.DateTimeOptio * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnTimePickerChangeCallback = (result: TimePickerResult) => void; @@ -347,7 +370,8 @@ declare type OnTimePickerChangeCallback = (result: TimePickerResult) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TimePickerAttribute extends CommonMethod { /** @@ -375,7 +399,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ useMilitaryTime(value: boolean): TimePickerAttribute; @@ -387,7 +412,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ useMilitaryTime(isMilitaryTime: Optional): TimePickerAttribute; @@ -406,7 +432,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ loop(value: boolean): TimePickerAttribute; @@ -417,7 +444,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ loop(isLoop: Optional): TimePickerAttribute; @@ -438,7 +466,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle(value: PickerTextStyle): TimePickerAttribute; @@ -450,7 +479,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle(style: Optional): TimePickerAttribute; @@ -471,7 +501,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle(value: PickerTextStyle): TimePickerAttribute; @@ -483,7 +514,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle(style: Optional): TimePickerAttribute; @@ -504,7 +536,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle(value: PickerTextStyle): TimePickerAttribute; @@ -516,7 +549,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle(style: Optional): TimePickerAttribute; @@ -528,8 +562,9 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 - */ + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ dateTimeOptions(value: DateTimeOptions): TimePickerAttribute; /** @@ -540,8 +575,9 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 - */ + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 + */ dateTimeOptions(timeFormat: Optional): TimePickerAttribute; /** @@ -581,7 +617,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: Optional): TimePickerAttribute; @@ -593,7 +630,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onEnterSelectedArea(callback: Callback): TimePickerAttribute; @@ -604,7 +642,8 @@ declare class TimePickerAttribute extends CommonMethod { * @returns { TimePickerAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(enable: boolean): TimePickerAttribute; @@ -615,7 +654,8 @@ declare class TimePickerAttribute extends CommonMethod { * @returns { TimePickerAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(enable: Optional): TimePickerAttribute; @@ -627,7 +667,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ digitalCrownSensitivity(sensitivity: Optional): TimePickerAttribute; @@ -639,7 +680,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableCascade(enabled: boolean): TimePickerAttribute; } @@ -669,7 +711,8 @@ declare class TimePickerAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TimePickerDialogOptions extends TimePickerOptions { /** @@ -694,7 +737,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ useMilitaryTime?: boolean; @@ -713,7 +757,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ disappearTextStyle?: PickerTextStyle; @@ -732,7 +777,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle?: PickerTextStyle; @@ -743,7 +789,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ acceptButtonStyle?: PickerDialogButtonStyle; @@ -754,7 +801,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ cancelButtonStyle?: PickerDialogButtonStyle; @@ -773,7 +821,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedTextStyle?: PickerTextStyle; @@ -792,7 +841,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maskRect?: Rectangle; @@ -811,7 +861,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: DialogAlignment; @@ -830,7 +881,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Offset; @@ -856,7 +908,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onAccept?: (value: TimePickerResult) => void; @@ -882,7 +935,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onCancel?: () => void; @@ -908,7 +962,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onChange?: (value: TimePickerResult) => void; @@ -919,7 +974,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onEnterSelectedArea?: Callback; @@ -940,7 +996,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; @@ -961,7 +1018,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; @@ -972,7 +1030,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyleOptions?: BackgroundBlurStyleOptions; @@ -983,7 +1042,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEffect?: BackgroundEffectOptions; @@ -995,7 +1055,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableCascade?: boolean; @@ -1006,7 +1067,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidAppear?: () => void; @@ -1017,7 +1079,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDidDisappear?: () => void; @@ -1028,7 +1091,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillAppear?: () => void; @@ -1039,7 +1103,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onWillDisappear?: () => void; @@ -1050,7 +1115,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -1061,7 +1127,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dateTimeOptions?: DateTimeOptions; @@ -1073,7 +1140,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -1085,7 +1153,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; @@ -1096,7 +1165,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback?: boolean; } @@ -1120,7 +1190,8 @@ declare interface TimePickerDialogOptions extends TimePickerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class TimePickerDialog { /** diff --git a/api/@internal/component/ets/toggle.d.ts b/api/@internal/component/ets/toggle.d.ts index b1344ab7c46dcb7bdc939fb532d31c7cd147c235..e579821163a51ed668e55f3b955399511808946f 100644 --- a/api/@internal/component/ets/toggle.d.ts +++ b/api/@internal/component/ets/toggle.d.ts @@ -18,6 +18,12 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource'; +import { ResourceColor } from './units'; +import { CommonConfiguration, Callback, CommonMethod, ContentModifier, Bindable } from './common'; +/*** endif */ + /** * Declare the type of status button * @@ -50,7 +56,8 @@ * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ToggleType { /** @@ -81,7 +88,8 @@ declare enum ToggleType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Checkbox, @@ -113,7 +121,8 @@ declare enum ToggleType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Switch, @@ -145,7 +154,8 @@ declare enum ToggleType { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Button, } @@ -157,7 +167,8 @@ declare enum ToggleType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SwitchStyle { /** @@ -167,7 +178,8 @@ declare interface SwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pointRadius?: number | Resource; @@ -178,7 +190,8 @@ declare interface SwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ unselectedColor?: ResourceColor; @@ -189,7 +202,8 @@ declare interface SwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pointColor?: ResourceColor; @@ -200,7 +214,8 @@ declare interface SwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ trackBorderRadius?: number | Resource; } @@ -213,7 +228,8 @@ declare interface SwitchStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ToggleConfiguration extends CommonConfiguration { @@ -224,7 +240,8 @@ declare interface ToggleConfiguration extends CommonConfiguration; } @@ -259,7 +278,8 @@ declare interface ToggleConfiguration extends CommonConfiguration) } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + isOn?: boolean | undefined | Bindable } /** @@ -367,7 +401,8 @@ declare interface ToggleOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ToggleInterface { /** @@ -417,7 +452,8 @@ interface ToggleInterface { * @crossplatform * @form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ (options: ToggleOptions): ToggleAttribute; } @@ -454,7 +490,8 @@ interface ToggleInterface { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ToggleAttribute extends CommonMethod { /** @@ -493,7 +530,8 @@ declare class ToggleAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onChange(callback: (isOn: boolean) => void): ToggleAttribute; @@ -505,7 +543,8 @@ declare class ToggleAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentModifier(modifier: ContentModifier): ToggleAttribute; @@ -545,7 +584,8 @@ declare class ToggleAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ selectedColor(value: ResourceColor): ToggleAttribute; @@ -585,7 +625,8 @@ declare class ToggleAttribute extends CommonMethod { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ switchPointColor(color: ResourceColor): ToggleAttribute; @@ -597,7 +638,8 @@ declare class ToggleAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ switchStyle(value: SwitchStyle): ToggleAttribute; } diff --git a/api/@internal/component/ets/ui_extension_component.d.ts b/api/@internal/component/ets/ui_extension_component.d.ts index 98f807a2e72805dd36ae2b259636860251c5ac2f..eac19b4aa3ca5ce3bc9a027ceb7bb15ee0d12457 100644 --- a/api/@internal/component/ets/ui_extension_component.d.ts +++ b/api/@internal/component/ets/ui_extension_component.d.ts @@ -18,13 +18,21 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import Want from '../../@ohos.app.ability.Want' +import { Callback, ErrorCallback,BusinessError } from '../../@ohos.base' +import { CommonMethod } from './common' +import { ComponentContent } from '../ComponentContent' +/*** endif */ + /** * Enumeration of different types of DpiFollowStrategy. * * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum DpiFollowStrategy { /** @@ -32,7 +40,8 @@ declare enum DpiFollowStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLLOW_HOST_DPI = 0, @@ -41,7 +50,8 @@ declare enum DpiFollowStrategy { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLLOW_UI_EXTENSION_ABILITY_DPI = 1, } @@ -77,7 +87,8 @@ declare enum WindowModeFollowStrategy { * @interface UIExtensionOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface UIExtensionOptions { /** @@ -88,7 +99,8 @@ declare interface UIExtensionOptions { * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ isTransferringCaller?: boolean; @@ -99,7 +111,8 @@ declare interface UIExtensionOptions { * @type { ?ComponentContent } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ placeholder?: ComponentContent; @@ -111,7 +124,8 @@ declare interface UIExtensionOptions { * @type { ?Record } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ areaChangePlaceholder?: Record; @@ -122,7 +136,8 @@ declare interface UIExtensionOptions { * @default DpiFollowStrategy.FOLLOW_UI_EXTENSION_ABILITY_DPI * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dpiFollowStrategy?: DpiFollowStrategy; @@ -167,6 +182,39 @@ declare interface TerminationInfo { want?: import('../api/@ohos.app.ability.Want').default; } +/** + * Indicates the information when the provider of the embedded UI is terminated. + * + * @interface TerminationInfo + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ +declare interface TerminationInfo { + /** + * Defines the termination code. + * + * @type { number } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + code: number; + + /** + * Defines the additional termination information. + * + * @type { ?Want } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + want?: Want; +} + /** * Get Callback from @ohos.base. * @@ -177,6 +225,17 @@ declare interface TerminationInfo { */ declare type ReceiveCallback = import('../api/@ohos.base').Callback>; +/** + * Get Callback from @ohos.base. + * + * @typedef { Callback> } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ +type ReceiveCallback = Callback>; + /** * This interface is used for send data to the UIExtensionAbility.
* It is returned from onRemoteReady callback of UIExtensionComponent
@@ -185,7 +244,8 @@ declare type ReceiveCallback = import('../api/@ohos.base').Callback } data * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ send(data: Record): void; @@ -226,7 +288,8 @@ declare interface UIExtensionProxy { * @throws { BusinessError } 100012 - Transferring data failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sendSync(data: Record): Record; @@ -246,7 +309,8 @@ declare interface UIExtensionProxy { * @param { Callback } callback - Callback of the listened event. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'asyncReceiverRegister', callback: Callback): void; @@ -266,7 +330,8 @@ declare interface UIExtensionProxy { * @param { Callback } callback - Callback of the listened event. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'syncReceiverRegister', callback: Callback): void; @@ -286,7 +351,8 @@ declare interface UIExtensionProxy { * @param { Callback } [callback] - Callback of the listened event. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'asyncReceiverRegister', callback?: Callback): void; @@ -306,7 +372,8 @@ declare interface UIExtensionProxy { * @param { Callback } [callback] - Callback of the listened event. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'syncReceiverRegister', callback?: Callback): void; } @@ -318,7 +385,8 @@ declare interface UIExtensionProxy { * @interface UIExtensionComponentInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIExtensionComponentInterface { /** @@ -346,6 +414,23 @@ interface UIExtensionComponentInterface { want: import('../api/@ohos.app.ability.Want').default, options?: UIExtensionOptions ): UIExtensionComponentAttribute; + + /** + * Construct the UIExtensionComponent.
+ * Called when the UIExtensionComponent is used. + * + * @param { import('../api/@ohos.app.ability.Want').default } want - indicates the want of UIExtensionAbility + * @param { UIExtensionOptions } [options] - Construction configuration of UIExtensionComponentAttribute + * @returns { UIExtensionComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + ( + want: Want, + options?: UIExtensionOptions + ): UIExtensionComponentAttribute; } /** @@ -354,7 +439,8 @@ interface UIExtensionComponentInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class UIExtensionComponentAttribute extends CommonMethod { /** @@ -369,6 +455,20 @@ declare class UIExtensionComponentAttribute extends CommonMethod ): UIExtensionComponentAttribute; + + /** + * @param { import('../api/@ohos.base').Callback } callback + * - callback called when remote UIExtensionAbility object is + *
ready for receive data + * @returns { UIExtensionComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @systemapi + * @since 20 + * @arkts 1.2 + */ + onRemoteReady( + callback: Callback + ): UIExtensionComponentAttribute; /** * @param { import('../api/@ohos.base').Callback<{ [key: string]: Object }> } callback @@ -383,7 +483,8 @@ declare class UIExtensionComponentAttribute extends CommonMethod + ): UIExtensionComponentAttribute; /** * Called when the provider of the embedded UI is terminated. @@ -438,7 +552,8 @@ declare class UIExtensionComponentAttribute extends CommonMethod): UIExtensionComponentAttribute; @@ -470,3 +585,4 @@ declare const UIExtensionComponent: UIExtensionComponentInterface; * @since 10 */ declare const UIExtensionComponentInstance: UIExtensionComponentAttribute; + diff --git a/api/@internal/component/ets/units.d.ts b/api/@internal/component/ets/units.d.ts index 5572f407f9664e66dd4a6029678b789a14cdcc5e..9c05110c4f3a2f7abb509457c87e37d8c25fefbc 100644 --- a/api/@internal/component/ets/units.d.ts +++ b/api/@internal/component/ets/units.d.ts @@ -18,6 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource as _Resource } from '../../global/resource'; +import { Color, BorderStyle, FontWeight, FontStyle, DividerMode} from './enums'; +import { OutlineStyle } from './common'; +import { LengthMetricsUnit as _LengthMetricsUnit, LengthMetrics as _LengthMetrics, ColorMetrics as _ColorMetrics } from '../Graphics'; +/*** endif */ + /** * Defines the data type of the interface restriction. * @@ -56,6 +63,19 @@ */ declare type Resource = import('../api/global/resource').Resource; +/** + * Defines the data type of the interface restriction. + * + * @typedef { _Resource } Resource + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type Resource = _Resource; + /** * Defines the length property with string, number and resource unit. * @@ -88,7 +108,8 @@ declare type Resource = import('../api/global/resource').Resource; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type Length = string | number | Resource; @@ -118,6 +139,17 @@ declare type Length = string | number | Resource; */ declare type PX = `${number}px`; + +/** + * Defines the length property with number in units of px. + * + * @typedef { string } PX + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type PX = string; /** * Defines the length property with number or number in units of vp. * @@ -144,6 +176,17 @@ declare type PX = `${number}px`; */ declare type VP = `${number}vp` | number; +/** + * Defines the length property with number or number in units of vp. + * + * @typedef { string | number } VP + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type VP = string | number; + /** * Defines the length property with number in units of fp. * @@ -170,6 +213,17 @@ declare type VP = `${number}vp` | number; */ declare type FP = `${number}fp`; +/** + * Defines the length property with number in units of fp. + * + * @typedef { string } FP + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type FP = string; + /** * Defines the length property with number in units of lpx. * @@ -196,6 +250,17 @@ declare type FP = `${number}fp`; */ declare type LPX = `${number}lpx`; +/** + * Defines the length property with number in units of lpx. + * + * @typedef { string } LPX + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type LPX = string; + /** * Defines the length property with number in units of Percentage. * @@ -222,6 +287,17 @@ declare type LPX = `${number}lpx`; */ declare type Percentage = `${number}%`; +/** + * Defines the length property with number in units of Percentage. + * + * @typedef { string } Percentage + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type Percentage = string; + /** * Defines the angle property with number in units of deg. * @@ -239,6 +315,17 @@ declare type Percentage = `${number}%`; */ declare type Degree = `${number}deg`; +/** + * Defines the angle property with number in units of deg. + * + * @typedef { string } Degree + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type Degree = string; + /** * Defines the dimension property with number with units(vp|px|fp|lpx|%), and resource. * @@ -261,7 +348,8 @@ declare type Degree = `${number}deg`; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type Dimension = PX | VP | FP | LPX | Percentage | Resource; @@ -297,7 +385,8 @@ declare type Dimension = PX | VP | FP | LPX | Percentage | Resource; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ResourceStr = string | Resource; @@ -330,9 +419,10 @@ declare type ResourceStr = string | Resource; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type Padding = { +declare interface Padding { /** * top property. * @@ -363,9 +453,10 @@ declare type Padding = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: Length; @@ -399,9 +490,10 @@ declare type Padding = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ right?: Length; @@ -435,9 +527,10 @@ declare type Padding = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: Length; @@ -471,12 +564,13 @@ declare type Padding = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: Length; -}; +} /** * Defines the localized padding property. @@ -486,7 +580,8 @@ declare type Padding = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedPadding { /** @@ -497,7 +592,8 @@ declare interface LocalizedPadding { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: LengthMetrics; @@ -509,7 +605,8 @@ declare interface LocalizedPadding { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end?: LengthMetrics; @@ -521,7 +618,8 @@ declare interface LocalizedPadding { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: LengthMetrics; @@ -533,10 +631,11 @@ declare interface LocalizedPadding { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: LengthMetrics; -}; +} /** * Defines the margin property. @@ -570,7 +669,8 @@ declare interface LocalizedPadding { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type Margin = Padding; @@ -589,7 +689,8 @@ declare type Margin = Padding; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type EdgeWidth = EdgeWidths; @@ -618,9 +719,10 @@ declare type EdgeWidth = EdgeWidths; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type EdgeWidths = { +declare interface EdgeWidths { /** * top property. * @@ -644,9 +746,10 @@ declare type EdgeWidths = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: Length; @@ -673,9 +776,10 @@ declare type EdgeWidths = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ right?: Length; @@ -702,9 +806,10 @@ declare type EdgeWidths = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: Length; @@ -731,12 +836,13 @@ declare type EdgeWidths = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: Length; -}; +} /** * Defines the localized border width property. @@ -746,7 +852,8 @@ declare type EdgeWidths = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedEdgeWidths { /** @@ -757,7 +864,8 @@ declare interface LocalizedEdgeWidths { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: LengthMetrics; @@ -769,7 +877,8 @@ declare interface LocalizedEdgeWidths { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end?: LengthMetrics; @@ -781,7 +890,8 @@ declare interface LocalizedEdgeWidths { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: LengthMetrics; @@ -793,7 +903,8 @@ declare interface LocalizedEdgeWidths { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: LengthMetrics; }; @@ -816,7 +927,18 @@ declare interface LocalizedEdgeWidths { * @atomicservice * @since 12 */ -declare type EdgeOutlineWidths = { +/** + * Defines the outline width property. + * + * @interface EdgeOutlineWidths + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +declare interface EdgeOutlineWidths { /** * top outline width property. * @@ -834,7 +956,8 @@ declare type EdgeOutlineWidths = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: Dimension; @@ -855,7 +978,8 @@ declare type EdgeOutlineWidths = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ right?: Dimension; @@ -876,7 +1000,8 @@ declare type EdgeOutlineWidths = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: Dimension; @@ -897,10 +1022,11 @@ declare type EdgeOutlineWidths = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ left?: Dimension; -}; +} /** * Defines the border radius property. @@ -927,9 +1053,10 @@ declare type EdgeOutlineWidths = { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type BorderRadiuses = { +declare interface BorderRadiuses { /** * top-left property. * @@ -953,9 +1080,10 @@ declare type BorderRadiuses = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ topLeft?: Length; @@ -982,9 +1110,10 @@ declare type BorderRadiuses = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ topRight?: Length; @@ -1011,9 +1140,10 @@ declare type BorderRadiuses = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottomLeft?: Length; @@ -1040,12 +1170,13 @@ declare type BorderRadiuses = { * @type { ?Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottomRight?: Length; -}; +} /** * Defines the localized border radius property. @@ -1055,7 +1186,8 @@ declare type BorderRadiuses = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedBorderRadiuses { /** @@ -1066,7 +1198,8 @@ declare interface LocalizedBorderRadiuses { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ topStart?: LengthMetrics; @@ -1078,7 +1211,8 @@ declare interface LocalizedBorderRadiuses { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ topEnd?: LengthMetrics; @@ -1090,7 +1224,8 @@ declare interface LocalizedBorderRadiuses { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottomStart?: LengthMetrics; @@ -1102,7 +1237,8 @@ declare interface LocalizedBorderRadiuses { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottomEnd?: LengthMetrics; }; @@ -1126,7 +1262,18 @@ declare interface LocalizedBorderRadiuses { * @atomicservice * @since 12 */ -declare type OutlineRadiuses = { +/** + * Defines the outline radius property. + * + * @interface OutlineRadiuses + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +declare interface OutlineRadiuses { /** * top-left property. * @@ -1144,7 +1291,8 @@ declare type OutlineRadiuses = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ topLeft?: Dimension; @@ -1165,7 +1313,8 @@ declare type OutlineRadiuses = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ topRight?: Dimension; @@ -1186,7 +1335,8 @@ declare type OutlineRadiuses = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottomLeft?: Dimension; @@ -1207,7 +1357,8 @@ declare type OutlineRadiuses = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottomRight?: Dimension; }; @@ -1237,9 +1388,10 @@ declare type OutlineRadiuses = { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type EdgeColors = { +declare interface EdgeColors { /** * top property. * @@ -1263,9 +1415,10 @@ declare type EdgeColors = { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: ResourceColor; @@ -1292,9 +1445,10 @@ declare type EdgeColors = { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ right?: ResourceColor; @@ -1321,9 +1475,10 @@ declare type EdgeColors = { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: ResourceColor; @@ -1350,12 +1505,13 @@ declare type EdgeColors = { * @type { ?ResourceColor } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: ResourceColor; -}; +} /** * Defines the localized border color property. @@ -1365,7 +1521,8 @@ declare type EdgeColors = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedEdgeColors { /** @@ -1376,7 +1533,8 @@ declare interface LocalizedEdgeColors { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: ResourceColor; @@ -1388,7 +1546,8 @@ declare interface LocalizedEdgeColors { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end?: ResourceColor; @@ -1400,7 +1559,8 @@ declare interface LocalizedEdgeColors { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: ResourceColor; @@ -1412,7 +1572,8 @@ declare interface LocalizedEdgeColors { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: ResourceColor; }; @@ -1425,7 +1586,8 @@ declare interface LocalizedEdgeColors { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type LocalizedMargin = LocalizedPadding; @@ -1454,9 +1616,10 @@ declare type LocalizedMargin = LocalizedPadding; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type EdgeStyles = { +declare interface EdgeStyles { /** * top property. * @@ -1480,9 +1643,10 @@ declare type EdgeStyles = { * @type { ?BorderStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ top?: BorderStyle; @@ -1509,9 +1673,10 @@ declare type EdgeStyles = { * @type { ?BorderStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ right?: BorderStyle; @@ -1538,9 +1703,10 @@ declare type EdgeStyles = { * @type { ?BorderStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: BorderStyle; @@ -1567,12 +1733,13 @@ declare type EdgeStyles = { * @type { ?BorderStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ left?: BorderStyle; -}; +} /** * Defines the outline style property. @@ -1593,7 +1760,18 @@ declare type EdgeStyles = { * @atomicservice * @since 12 */ -declare type EdgeOutlineStyles = { +/** + * Defines the outline style property. + * + * @interface EdgeOutlineStyles + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +declare interface EdgeOutlineStyles { /** * top property. * @@ -1611,7 +1789,8 @@ declare type EdgeOutlineStyles = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: OutlineStyle; @@ -1632,7 +1811,8 @@ declare type EdgeOutlineStyles = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ right?: OutlineStyle; @@ -1653,7 +1833,8 @@ declare type EdgeOutlineStyles = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: OutlineStyle; @@ -1674,10 +1855,11 @@ declare type EdgeOutlineStyles = { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ left?: OutlineStyle; -}; +} /** * Defines the offset property. @@ -1701,9 +1883,10 @@ declare type EdgeOutlineStyles = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type Offset = { +declare interface Offset { /** * dx property. * @@ -1726,7 +1909,8 @@ declare type Offset = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ dx: Length; @@ -1752,10 +1936,11 @@ declare type Offset = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ dy: Length; -}; +} /** * Defines the color which can use resource. @@ -1789,7 +1974,8 @@ declare type Offset = { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare type ResourceColor = Color | number | string | Resource; @@ -1818,9 +2004,10 @@ declare type ResourceColor = Color | number | string | Resource; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ -declare type LengthConstrain = { +declare interface LengthConstrain { /** * minimum length. * @@ -1844,9 +2031,10 @@ declare type LengthConstrain = { * @type { Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ minLength: Length; @@ -1873,12 +2061,13 @@ declare type LengthConstrain = { * @type { Length } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @atomicservice - * @since 11 * @form + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxLength: Length; -}; +} /** * Defines VoidCallback. @@ -1887,7 +2076,8 @@ declare type LengthConstrain = { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type VoidCallback = () => void; @@ -1903,6 +2093,19 @@ declare type VoidCallback = () => void; */ declare type LengthMetricsUnit = import('../api/arkui/Graphics').LengthMetricsUnit; +/** + * Defines length metrics unit. + * + * @typedef { _LengthMetricsUnit } LengthMetricsUnit + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type LengthMetricsUnit = _LengthMetricsUnit; + /** * Defines LengthMetrics. * @@ -1914,6 +2117,18 @@ declare type LengthMetricsUnit = import('../api/arkui/Graphics').LengthMetricsUn */ declare type LengthMetrics = import('../api/arkui/Graphics').LengthMetrics; +/** + * Defines LengthMetrics. + * + * @typedef { _LengthMetrics } LengthMetrics + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type LengthMetrics = _LengthMetrics; + /** * Defines ColorMetrics. * @@ -1925,6 +2140,18 @@ declare type LengthMetrics = import('../api/arkui/Graphics').LengthMetrics; */ declare type ColorMetrics = import('../api/arkui/Graphics').ColorMetrics; +/** + * Defines ColorMetrics. + * + * @typedef { _ColorMetrics } ColorMetrics + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare type ColorMetrics = _ColorMetrics; + /** * Defines the font used for text. * @@ -1947,7 +2174,8 @@ declare type ColorMetrics = import('../api/arkui/Graphics').ColorMetrics; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Font { /** @@ -1972,7 +2200,8 @@ declare interface Font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size?: Length; @@ -1998,7 +2227,8 @@ declare interface Font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ weight?: FontWeight | number | string; @@ -2024,7 +2254,8 @@ declare interface Font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ family?: string | Resource; @@ -2050,7 +2281,8 @@ declare interface Font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: FontStyle; } @@ -2087,7 +2319,8 @@ declare interface Font { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Area { /** @@ -2122,7 +2355,8 @@ declare interface Area { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width: Length; @@ -2158,7 +2392,8 @@ declare interface Area { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height: Length; @@ -2194,7 +2429,8 @@ declare interface Area { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ position: Position; @@ -2230,7 +2466,8 @@ declare interface Area { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ globalPosition: Position; } @@ -2267,7 +2504,8 @@ declare interface Area { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Position { /** @@ -2302,7 +2540,8 @@ declare interface Position { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: Length; @@ -2338,7 +2577,8 @@ declare interface Position { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: Length; } @@ -2350,7 +2590,8 @@ declare interface Position { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedPosition { /** @@ -2360,7 +2601,8 @@ declare interface LocalizedPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: LengthMetrics; @@ -2371,7 +2613,8 @@ declare interface LocalizedPosition { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: LengthMetrics; } @@ -2384,7 +2627,8 @@ declare interface LocalizedPosition { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Edges { /** @@ -2395,7 +2639,8 @@ declare interface Edges { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: Dimension; @@ -2407,7 +2652,8 @@ declare interface Edges { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ left?: Dimension; @@ -2419,7 +2665,8 @@ declare interface Edges { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: Dimension; @@ -2431,7 +2678,8 @@ declare interface Edges { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ right?: Dimension; } @@ -2443,7 +2691,8 @@ declare interface Edges { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LocalizedEdges { /** @@ -2453,7 +2702,8 @@ declare interface LocalizedEdges { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top?: LengthMetrics; @@ -2464,7 +2714,8 @@ declare interface LocalizedEdges { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start?: LengthMetrics; @@ -2475,7 +2726,8 @@ declare interface LocalizedEdges { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: LengthMetrics; @@ -2486,7 +2738,8 @@ declare interface LocalizedEdges { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end?: LengthMetrics; } @@ -2508,7 +2761,8 @@ declare interface LocalizedEdges { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Bias { /** @@ -2530,7 +2784,8 @@ declare interface Bias { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ horizontal?: number; @@ -2553,7 +2808,8 @@ declare interface Bias { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ vertical?: number; } @@ -2590,7 +2846,8 @@ declare interface Bias { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ConstraintSizeOptions { /** @@ -2625,7 +2882,8 @@ declare interface ConstraintSizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ minWidth?: Length; @@ -2661,7 +2919,8 @@ declare interface ConstraintSizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxWidth?: Length; @@ -2697,7 +2956,8 @@ declare interface ConstraintSizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ minHeight?: Length; @@ -2733,7 +2993,8 @@ declare interface ConstraintSizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxHeight?: Length; } @@ -2770,7 +3031,8 @@ declare interface ConstraintSizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SizeOptions { /** @@ -2805,7 +3067,8 @@ declare interface SizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Length; @@ -2841,7 +3104,8 @@ declare interface SizeOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: Length; } @@ -2888,7 +3152,8 @@ declare interface SizeOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BorderOptions { /** @@ -2933,7 +3198,8 @@ declare interface BorderOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: EdgeWidths | Length | LocalizedEdgeWidths; @@ -2979,7 +3245,8 @@ declare interface BorderOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: EdgeColors | ResourceColor | LocalizedEdgeColors; @@ -3025,7 +3292,8 @@ declare interface BorderOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: BorderRadiuses | Length | LocalizedBorderRadiuses; @@ -3061,7 +3329,8 @@ declare interface BorderOptions { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ style?: EdgeStyles | BorderStyle; @@ -3072,7 +3341,8 @@ declare interface BorderOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dashGap?: EdgeWidths | LengthMetrics | LocalizedEdgeWidths; @@ -3083,7 +3353,8 @@ declare interface BorderOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dashWidth?: EdgeWidths | LengthMetrics | LocalizedEdgeWidths; } @@ -3105,7 +3376,8 @@ declare interface BorderOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OutlineOptions { /** @@ -3125,7 +3397,8 @@ declare interface OutlineOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: EdgeOutlineWidths | Dimension; @@ -3146,7 +3419,8 @@ declare interface OutlineOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: EdgeColors | ResourceColor | LocalizedEdgeColors; @@ -3167,7 +3441,8 @@ declare interface OutlineOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: OutlineRadiuses | Dimension; @@ -3188,7 +3463,8 @@ declare interface OutlineOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ style?: EdgeOutlineStyles | OutlineStyle; } @@ -3208,7 +3484,8 @@ declare interface OutlineOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface MarkStyle { /** @@ -3226,7 +3503,8 @@ declare interface MarkStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeColor?: ResourceColor; @@ -3245,7 +3523,8 @@ declare interface MarkStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size?: Length; @@ -3264,7 +3543,8 @@ declare interface MarkStyle { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: Length; } @@ -3291,7 +3571,8 @@ declare interface MarkStyle { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class ColorFilter { /** @@ -3319,7 +3600,8 @@ declare class ColorFilter { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(value: number[]); } @@ -3346,7 +3628,8 @@ declare class ColorFilter { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface TouchPoint { /** @@ -3371,7 +3654,8 @@ declare interface TouchPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ x: Dimension; @@ -3397,7 +3681,8 @@ declare interface TouchPoint { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ y: Dimension; } @@ -3410,7 +3695,8 @@ declare interface TouchPoint { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DirectionalEdgesT { /** @@ -3421,7 +3707,8 @@ declare interface DirectionalEdgesT { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start: T; @@ -3433,7 +3720,8 @@ declare interface DirectionalEdgesT { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ end: T; @@ -3445,7 +3733,8 @@ declare interface DirectionalEdgesT { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ top: T; @@ -3457,7 +3746,8 @@ declare interface DirectionalEdgesT { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ bottom: T; } @@ -3469,7 +3759,8 @@ declare interface DirectionalEdgesT { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface DividerStyleOptions { /** @@ -3479,7 +3770,8 @@ declare interface DividerStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strokeWidth?: LengthMetrics; @@ -3490,7 +3782,8 @@ declare interface DividerStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: ResourceColor; @@ -3501,7 +3794,8 @@ declare interface DividerStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ startMargin?: LengthMetrics; @@ -3512,7 +3806,8 @@ declare interface DividerStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ endMargin?: LengthMetrics; @@ -3523,7 +3818,8 @@ declare interface DividerStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ mode?: DividerMode; } @@ -3535,7 +3831,8 @@ declare interface DividerStyleOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ChainWeightOptions { /** @@ -3545,7 +3842,8 @@ declare interface ChainWeightOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ horizontal?: number; @@ -3556,7 +3854,8 @@ declare interface ChainWeightOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ vertical?: number; } @@ -3568,7 +3867,8 @@ declare interface ChainWeightOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AccessibilityOptions { /** @@ -3578,7 +3878,8 @@ declare interface AccessibilityOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ accessibilityPreferred?: boolean; } diff --git a/api/@internal/component/ets/video.d.ts b/api/@internal/component/ets/video.d.ts index bac70284feb0a0ebea7aa90b7d4bc877d1f10947..729c9e5292fa7c291eab7d4f1395e3038593564b 100644 --- a/api/@internal/component/ets/video.d.ts +++ b/api/@internal/component/ets/video.d.ts @@ -18,6 +18,14 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from '../../global/resource'; +import { ImageAIOptions, ImageAnalyzerConfig } from './imageCommon'; +import { ImageFit } from './enums'; +import { CommonMethod, Callback, PixelMap } from './common'; +import { VoidCallback, ColorMetrics } from './units'; +/*** endif */ + /** * Seek mode. * @@ -40,7 +48,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SeekMode { /** @@ -62,7 +71,8 @@ declare enum SeekMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PreviousKeyframe, @@ -85,7 +95,8 @@ declare enum SeekMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NextKeyframe, @@ -108,7 +119,8 @@ declare enum SeekMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ClosestKeyframe, @@ -131,7 +143,8 @@ declare enum SeekMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Accurate, } @@ -158,7 +171,8 @@ declare enum SeekMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum PlaybackSpeed { /** @@ -180,7 +194,8 @@ declare enum PlaybackSpeed { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Speed_Forward_0_75_X, @@ -203,7 +218,8 @@ declare enum PlaybackSpeed { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Speed_Forward_1_00_X, @@ -226,7 +242,8 @@ declare enum PlaybackSpeed { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Speed_Forward_1_25_X, @@ -249,7 +266,8 @@ declare enum PlaybackSpeed { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Speed_Forward_1_75_X, @@ -272,7 +290,8 @@ declare enum PlaybackSpeed { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Speed_Forward_2_00_X, } @@ -284,7 +303,8 @@ declare enum PlaybackSpeed { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface FullscreenInfo { /** @@ -301,7 +321,8 @@ interface FullscreenInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fullscreen: boolean; } @@ -313,7 +334,8 @@ interface FullscreenInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface PreparedInfo { /** @@ -330,7 +352,8 @@ interface PreparedInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration: number; } @@ -342,7 +365,8 @@ interface PreparedInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface PlaybackInfo { /** @@ -359,7 +383,8 @@ interface PlaybackInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ time: number; } @@ -370,7 +395,8 @@ interface PlaybackInfo { * @interface PosterOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface PosterOptions { /** @@ -380,7 +406,8 @@ declare interface PosterOptions { * @default false * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ showFirstFrame?: boolean; } @@ -416,7 +443,8 @@ declare interface PosterOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface VideoOptions { /** @@ -441,7 +469,8 @@ declare interface VideoOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ src?: string | Resource; @@ -467,7 +496,8 @@ declare interface VideoOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ currentProgressRate?: number | string | PlaybackSpeed; @@ -493,7 +523,8 @@ declare interface VideoOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ previewUri?: string | PixelMap | Resource; @@ -519,7 +550,8 @@ declare interface VideoOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ controller?: VideoController; @@ -529,7 +561,8 @@ declare interface VideoOptions { * @type { ?ImageAIOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ imageAIOptions?: ImageAIOptions; @@ -539,7 +572,8 @@ declare interface VideoOptions { * @type { ?PosterOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ posterOptions?: PosterOptions; } @@ -563,7 +597,8 @@ declare interface VideoOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class VideoController { /** @@ -585,7 +620,8 @@ declare class VideoController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -612,6 +648,17 @@ declare class VideoController { */ start(); + /** + * Provides events to play. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + start(): void; + /** * Provides a pause event for playback. * @@ -635,6 +682,17 @@ declare class VideoController { */ pause(); + /** + * Provides a pause event for playback. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + pause(): void; + /** * Provides an event to stop playback. * @@ -658,6 +716,17 @@ declare class VideoController { */ stop(); + /** + * Provides an event to stop playback. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + stop(): void; + /** * Provide the progress method of video playback. * @@ -684,6 +753,18 @@ declare class VideoController { */ setCurrentTime(value: number); + /** + * Provide the progress method of video playback. + * + * @param { number } value + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + setCurrentTime(value: number): void; + /** * Provides a full screen playback method. * @@ -710,6 +791,18 @@ declare class VideoController { */ requestFullscreen(value: boolean); + /** + * Provides a full screen playback method. + * + * @param { boolean } value + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + requestFullscreen(value: boolean): void; + /** * Provides a method to exit full screen playback. * @@ -733,6 +826,17 @@ declare class VideoController { */ exitFullscreen(); + /** + * Provides a method to exit full screen playback. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + exitFullscreen(): void; + /** * Provide the progress method of video playback. * @@ -762,12 +866,26 @@ declare class VideoController { */ setCurrentTime(value: number, seekMode: SeekMode); + /** + * Provide the progress method of video playback. + * + * @param { number } value + * @param { SeekMode } seekMode + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + setCurrentTime(value: number, seekMode: SeekMode): void; + /** * Provide the reset method of video playback. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ reset(): void; } @@ -794,7 +912,8 @@ declare class VideoController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface VideoInterface { /** @@ -822,7 +941,8 @@ interface VideoInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (value: VideoOptions): VideoAttribute; } @@ -849,7 +969,8 @@ interface VideoInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class VideoAttribute extends CommonMethod { /** @@ -877,7 +998,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ muted(value: boolean): VideoAttribute; @@ -906,7 +1028,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ autoPlay(value: boolean): VideoAttribute; @@ -935,7 +1058,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ controls(value: boolean): VideoAttribute; @@ -964,7 +1088,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ loop(value: boolean): VideoAttribute; @@ -993,7 +1118,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ objectFit(value: ImageFit): VideoAttribute; @@ -1032,7 +1158,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onStart(event: VoidCallback): VideoAttribute; @@ -1071,7 +1198,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onPause(event: VoidCallback): VideoAttribute; @@ -1110,7 +1238,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish(event: VoidCallback): VideoAttribute; @@ -1149,7 +1278,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onFullscreenChange(callback: Callback): VideoAttribute; @@ -1188,7 +1318,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onPrepared(callback: Callback): VideoAttribute; @@ -1227,7 +1358,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onSeeking(callback: Callback): VideoAttribute; @@ -1266,7 +1398,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onSeeked(callback: Callback): VideoAttribute; @@ -1305,7 +1438,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onUpdate(callback: Callback): VideoAttribute; @@ -1334,7 +1468,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onError(event: () => void): VideoAttribute; @@ -1346,7 +1481,8 @@ declare class VideoAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onStop(event: Callback): VideoAttribute; @@ -1357,7 +1493,8 @@ declare class VideoAttribute extends CommonMethod { * @returns { VideoAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAnalyzer(enable: boolean): VideoAttribute; @@ -1368,7 +1505,8 @@ declare class VideoAttribute extends CommonMethod { * @returns { VideoAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ analyzerConfig(config: ImageAnalyzerConfig): VideoAttribute; @@ -1379,7 +1517,8 @@ declare class VideoAttribute extends CommonMethod { * @returns { VideoAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ surfaceBackgroundColor(color: ColorMetrics): VideoAttribute; @@ -1394,7 +1533,8 @@ declare class VideoAttribute extends CommonMethod { * @returns { VideoAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ enableShortcutKey(enabled: boolean): VideoAttribute; } diff --git a/api/@internal/component/ets/water_flow.d.ts b/api/@internal/component/ets/water_flow.d.ts index e1fdd93aee657d46842e34e0da3babde9f2aa0ab..937e7eb9b7e5f458bbe0351f8fd5fe256cdfe71c 100644 --- a/api/@internal/component/ets/water_flow.d.ts +++ b/api/@internal/component/ets/water_flow.d.ts @@ -18,6 +18,16 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ScrollableCommonMethod, NestedScrollOptions, CommonMethod, Optional, OnWillScrollCallback, OnScrollCallback } from './common'; +import { CustomBuilder } from './builder' +import { Length, Dimension, Margin, ConstraintSizeOptions, Resource } from './units'; +import { Scroller, OnScrollFrameBeginCallback } from './scroll'; +import { ScrollState } from './list' +import { FlexDirection } from './enums' +import { ComponentContent } from '../../arkui/ComponentContent' +/*** endif */ + /** * function that returns item main size by index. * @@ -27,7 +37,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare type GetItemMainSizeByIndex = (index: number) => number; @@ -37,7 +48,8 @@ declare type GetItemMainSizeByIndex = (index: number) => number; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class SectionOptions { /** @@ -47,7 +59,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ itemsCount: number; @@ -59,7 +72,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ crossCount?: number; @@ -71,7 +85,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onGetItemMainSizeByIndex?: GetItemMainSizeByIndex; @@ -83,7 +98,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ columnsGap?: Dimension; @@ -95,7 +111,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rowsGap?: Dimension; @@ -107,7 +124,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: Margin | Dimension; } @@ -118,7 +136,8 @@ declare class SectionOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class WaterFlowSections { /** @@ -127,7 +146,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -141,7 +161,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ splice(start: number, deleteCount?: number, sections?: Array): boolean; @@ -153,7 +174,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ push(section: SectionOptions): boolean; @@ -166,7 +188,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ update(sectionIndex:number, section: SectionOptions): boolean; @@ -177,7 +200,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ values(): Array; @@ -188,7 +212,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ length(): number; } @@ -200,7 +225,8 @@ declare class WaterFlowSections { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WaterFlowLayoutMode { /** @@ -209,7 +235,8 @@ declare enum WaterFlowLayoutMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALWAYS_TOP_DOWN = 0, @@ -219,7 +246,8 @@ declare enum WaterFlowLayoutMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SLIDING_WINDOW = 1, } @@ -246,7 +274,8 @@ declare enum WaterFlowLayoutMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface WaterFlowOptions { /** @@ -271,7 +300,8 @@ declare interface WaterFlowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ footer?: CustomBuilder; @@ -282,7 +312,8 @@ declare interface WaterFlowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ footerContent?: ComponentContent; @@ -308,7 +339,8 @@ declare interface WaterFlowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scroller?: Scroller; @@ -319,7 +351,8 @@ declare interface WaterFlowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sections?: WaterFlowSections; @@ -330,7 +363,8 @@ declare interface WaterFlowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ layoutMode?: WaterFlowLayoutMode; } @@ -357,7 +391,8 @@ declare interface WaterFlowOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface WaterFlowInterface { /** @@ -385,7 +420,8 @@ interface WaterFlowInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ (options?: WaterFlowOptions): WaterFlowAttribute; } @@ -412,7 +448,8 @@ interface WaterFlowInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare class WaterFlowAttribute extends ScrollableCommonMethod { /** @@ -440,7 +477,8 @@ declare class WaterFlowAttribute extends ScrollableCommonMethod { offsetRemain: number }): WaterFlowAttribute; + /** + * Called when scrolling begin each frame. + * Anonymous Object Rectification. + * + * @param { OnScrollFrameBeginCallback } event - callback function, triggered when the scrolling begin each frame. + * @returns { WaterFlowAttribute } the attribute of the water flow. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ + onScrollFrameBegin(event: OnScrollFrameBeginCallback): WaterFlowAttribute; /** * Called when the first or last item displayed in the waterflow changes. @@ -768,9 +825,35 @@ declare class WaterFlowAttribute extends ScrollableCommonMethod void): WaterFlowAttribute; + + /** + * Called when the scrollable will scroll. + * + * @param { Optional } handler - callback of scrollable. + * @returns { WaterFlowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onWillScroll(handler: Optional): WaterFlowAttribute; + + /** + * Called when the scrollable did scroll. + * + * @param { OnScrollCallback } handler - callback of scrollable, + * scrollOffset is offset this frame did scroll, scrollState is current scroll state. + * @returns { WaterFlowAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDidScroll(handler: OnScrollCallback): WaterFlowAttribute; } /** diff --git a/api/@internal/component/ets/web.d.ts b/api/@internal/component/ets/web.d.ts index 9bedff19269370b7e81c3ceb691c81616138cfd7..66dce258768e3590b299233ca6418f065b22042e 100644 --- a/api/@internal/component/ets/web.d.ts +++ b/api/@internal/component/ets/web.d.ts @@ -18,6 +18,29 @@ * @kit ArkWeb */ +/*** if arkts 1.2 */ +import webview from '../../@ohos.web.webview'; +import image from '../../@ohos.multimedia.image'; +import { CommonMethod, Callback, TouchEvent, NestedScrollOptions, KeyEvent } from './common'; +import { CustomBuilder } from './builder' +import { Resource } from '../../global/resource'; +import { Position, ResourceStr } from './units'; +import { MenuType, EditMenuOptions } from './textCommon'; +import { CopyOptions, NestedScrollMode } from './enums'; +/*** endif */ + +/** +* Provides methods for controlling the web controller. +* +* @typedef { webview.WebviewController } +* @syscap SystemCapability.Web.Webview.Core +* @crossplatform +* @atomicservice +* @since 20 +* @arkts 1.2 +*/ +type WebviewController = webview.WebviewController; + /** * Provides methods for controlling the web controller. * @@ -49,7 +72,8 @@ declare type WebviewController = import('../api/@ohos.web.webview').default.Webv * @param { LoadCommittedDetails } loadCommittedDetails - callback information of onNavigationEntryCommitted. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnNavigationEntryCommittedCallback = (loadCommittedDetails: LoadCommittedDetails) => void; @@ -60,7 +84,8 @@ type OnNavigationEntryCommittedCallback = (loadCommittedDetails: LoadCommittedDe * @param { SslErrorEvent } sslErrorEvent - callback information of onSslErrorEvent. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnSslErrorEventCallback = (sslErrorEvent: SslErrorEvent) => void; @@ -71,7 +96,8 @@ type OnSslErrorEventCallback = (sslErrorEvent: SslErrorEvent) => void; * @param { LargestContentfulPaint } largestContentfulPaint - callback information of onLargestContentfulPaint. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnLargestContentfulPaintCallback = (largestContentfulPaint: LargestContentfulPaint) => void; @@ -82,7 +108,8 @@ type OnLargestContentfulPaintCallback = (largestContentfulPaint: LargestContentf * @param { FirstMeaningfulPaint } firstMeaningfulPaint - callback information of onFirstMeaningfulPaint. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnFirstMeaningfulPaintCallback = (firstMeaningfulPaint: FirstMeaningfulPaint) => void; @@ -96,7 +123,8 @@ type OnFirstMeaningfulPaintCallback = (firstMeaningfulPaint: FirstMeaningfulPain * false causes the Web to continue loading the url as usual. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnOverrideUrlLoadingCallback = (webResourceRequest: WebResourceRequest) => boolean; @@ -107,7 +135,8 @@ type OnOverrideUrlLoadingCallback = (webResourceRequest: WebResourceRequest) => * @param { IntelligentTrackingPreventionDetails } details - callback information of onIntelligentTrackingPrevention. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnIntelligentTrackingPreventionCallback = (details: IntelligentTrackingPreventionDetails) => void; @@ -117,7 +146,8 @@ type OnIntelligentTrackingPreventionCallback = (details: IntelligentTrackingPrev * @typedef { function } OnNativeEmbedVisibilityChangeCallback * @param { NativeEmbedVisibilityInfo } nativeEmbedVisibilityInfo - callback information of onNativeEmbedVisibilityChange. * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnNativeEmbedVisibilityChangeCallback = (nativeEmbedVisibilityInfo: NativeEmbedVisibilityInfo) => void; @@ -127,7 +157,8 @@ type OnNativeEmbedVisibilityChangeCallback = (nativeEmbedVisibilityInfo: NativeE * @typedef NativeMediaPlayerConfig * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NativeMediaPlayerConfig { /** @@ -136,7 +167,8 @@ declare interface NativeMediaPlayerConfig { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enable: boolean; @@ -146,7 +178,8 @@ declare interface NativeMediaPlayerConfig { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ shouldOverlay: boolean; } @@ -157,7 +190,8 @@ declare interface NativeMediaPlayerConfig { * @typedef { function } OnRenderProcessNotRespondingCallback * @param { RenderProcessNotRespondingData } data - details of onRenderProcessNotResponding. * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnRenderProcessNotRespondingCallback = (data : RenderProcessNotRespondingData) => void; @@ -166,18 +200,20 @@ type OnRenderProcessNotRespondingCallback = (data : RenderProcessNotRespondingDa * * @typedef { function } OnRenderProcessRespondingCallback * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnRenderProcessRespondingCallback = () => void; /** - * The callback of ViewportFit Changed. +* The callback of ViewportFit Changed. * * @typedef { function } OnViewportFitChangedCallback * @param { ViewportFit } viewportFit - details of OnViewportFitChangedCallback. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnViewportFitChangedCallback = (viewportFit: ViewportFit) => void; @@ -188,7 +224,8 @@ type OnViewportFitChangedCallback = (viewportFit: ViewportFit) => void; * @param { AdsBlockedDetails } details - details of OnAdsBlockedCallback. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnAdsBlockedCallback = (details: AdsBlockedDetails) => void; @@ -198,7 +235,8 @@ type OnAdsBlockedCallback = (details: AdsBlockedDetails) => void; * @interface AdsBlockedDetails * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AdsBlockedDetails { /** @@ -207,7 +245,8 @@ declare interface AdsBlockedDetails { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -217,7 +256,8 @@ declare interface AdsBlockedDetails { * @type { Array } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ adsBlocked: Array; } @@ -228,7 +268,8 @@ declare interface AdsBlockedDetails { * @interface WebKeyboardOptions * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface WebKeyboardOptions { /** @@ -237,27 +278,28 @@ declare interface WebKeyboardOptions { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ useSystemKeyboard: boolean; - /** * Set the enter key type when the system keyboard is used, the "enter" key related to the {@link inputMethodEngine}. * * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType?: number; - /** * Set the custom keyboard builder when the custom keyboard is used. * * @type { ?CustomBuilder } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ customKeyboard?: CustomBuilder; } @@ -267,7 +309,8 @@ declare interface WebKeyboardOptions { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebKeyboardController { /** @@ -275,7 +318,8 @@ declare class WebKeyboardController { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -284,42 +328,43 @@ declare class WebKeyboardController { * * @param { string } text - text which will be inserted. * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ insertText(text: string): void; - /** * Delete text from back to front. * * @param { number } length - length of text, which will be deleted from back to front. * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteForward(length: number): void; - /** * Delete text from front to back. * * @param { number } length - length of text, which will be deleted from front to back. * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteBackward(length: number): void; - /** * Send the function of the key. * * @param { number } key - action indicates the "enter" key related to the {@link inputMethodEngine} * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ sendFunctionKey(key: number): void; - /** * Close the custom keyboard. * * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; } @@ -330,7 +375,8 @@ declare class WebKeyboardController { * @interface WebKeyboardCallbackInfo * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface WebKeyboardCallbackInfo { /** @@ -339,17 +385,18 @@ declare interface WebKeyboardCallbackInfo { * @type { WebKeyboardController } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ controller: WebKeyboardController; - /** * The attributes of web input element. * * @type { Record } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ attributes: Record; } @@ -362,7 +409,8 @@ declare interface WebKeyboardCallbackInfo { * @returns { WebKeyboardOptions } Return the web keyboard options of this web component. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type WebKeyboardCallback = (keyboardCallbackInfo: WebKeyboardCallbackInfo) => WebKeyboardOptions; @@ -380,7 +428,8 @@ type WebKeyboardCallback = (keyboardCallbackInfo: WebKeyboardCallbackInfo) => We * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MessageLevel { /** @@ -395,7 +444,8 @@ declare enum MessageLevel { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Debug = 0, @@ -411,7 +461,8 @@ declare enum MessageLevel { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Error = 1, @@ -427,7 +478,8 @@ declare enum MessageLevel { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Info = 2, @@ -443,7 +495,8 @@ declare enum MessageLevel { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Log = 3, @@ -459,7 +512,8 @@ declare enum MessageLevel { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Warn = 4 } @@ -486,7 +540,8 @@ declare enum MessageLevel { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum MixedMode { /** @@ -508,7 +563,8 @@ declare enum MixedMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ All = 0, @@ -531,7 +587,8 @@ declare enum MixedMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ Compatible = 1, @@ -554,7 +611,8 @@ declare enum MixedMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ None = 2 } @@ -566,7 +624,8 @@ declare enum MixedMode { * @param { ThreatType } threatType - callback information of onSafeBrowsingCheckResult. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnSafeBrowsingCheckResultCallback = (threatType: ThreatType) => void; @@ -583,7 +642,8 @@ type OnSafeBrowsingCheckResultCallback = (threatType: ThreatType) => void; * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum HitTestType { /** @@ -597,7 +657,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EditText = 0, @@ -612,7 +673,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Email = 1, @@ -627,7 +689,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ HttpAnchor = 2, @@ -642,7 +705,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ HttpAnchorImg = 3, @@ -657,7 +721,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Img = 4, @@ -672,7 +737,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Map = 5, @@ -687,7 +753,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Phone = 6, @@ -702,7 +769,8 @@ declare enum HitTestType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Unknown = 7 } @@ -729,7 +797,8 @@ declare enum HitTestType { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum CacheMode { /** @@ -751,7 +820,8 @@ declare enum CacheMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ Default = 0, @@ -774,7 +844,8 @@ declare enum CacheMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ None = 1, @@ -792,13 +863,14 @@ declare enum CacheMode { * @since 11 */ /** - * Load online and not cache. - * - * @syscap SystemCapability.Web.Webview.Core - * @crossplatform - * @atomicservice - * @since 18 - */ + * Load online and not cache. + * + * @syscap SystemCapability.Web.Webview.Core + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ Online = 2, /** @@ -820,7 +892,8 @@ declare enum CacheMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ Only = 3 } @@ -831,7 +904,8 @@ declare enum CacheMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum OverScrollMode { /** @@ -839,7 +913,8 @@ declare enum OverScrollMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NEVER = 0, @@ -848,7 +923,8 @@ declare enum OverScrollMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ALWAYS = 1 } @@ -859,7 +935,8 @@ declare enum OverScrollMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum BlurOnKeyboardHideMode { /** @@ -867,7 +944,8 @@ declare enum BlurOnKeyboardHideMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SILENT = 0, @@ -876,7 +954,8 @@ declare enum BlurOnKeyboardHideMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ BLUR = 1 } @@ -894,7 +973,8 @@ declare enum BlurOnKeyboardHideMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebDarkMode { /** @@ -908,7 +988,8 @@ declare enum WebDarkMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Off = 0, @@ -923,7 +1004,8 @@ declare enum WebDarkMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ On = 1, @@ -938,7 +1020,8 @@ declare enum WebDarkMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Auto = 2 } @@ -956,7 +1039,8 @@ declare enum WebDarkMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebCaptureMode { /** @@ -968,7 +1052,8 @@ declare enum WebCaptureMode { * The home screen. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ HOME_SCREEN = 0 } @@ -979,7 +1064,8 @@ declare enum WebCaptureMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ThreatType { /** @@ -987,7 +1073,8 @@ declare enum ThreatType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ THREAT_ILLEGAL = 0, @@ -996,7 +1083,8 @@ declare enum ThreatType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ THREAT_FRAUD = 1, @@ -1005,7 +1093,8 @@ declare enum ThreatType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ THREAT_RISK = 2, @@ -1015,7 +1104,8 @@ declare enum ThreatType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ THREAT_WARNING = 3 } @@ -1041,7 +1131,8 @@ declare enum ThreatType { * @typedef WebMediaOptions * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface WebMediaOptions { /** @@ -1057,10 +1148,10 @@ declare interface WebMediaOptions { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ resumeInterval?: number; - /** * Whether the audio of each web is exclusive. * @@ -1074,7 +1165,8 @@ declare interface WebMediaOptions { * @type { ?boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ audioExclusive?: boolean; } @@ -1100,7 +1192,8 @@ declare interface WebMediaOptions { * @typedef ScreenCaptureConfig * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScreenCaptureConfig { /** @@ -1116,7 +1209,8 @@ declare interface ScreenCaptureConfig { * @type { WebCaptureMode } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ captureMode: WebCaptureMode; } @@ -1140,7 +1234,8 @@ declare interface ScreenCaptureConfig { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class FullScreenExitHandler { /** @@ -1162,7 +1257,8 @@ declare class FullScreenExitHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1185,7 +1281,8 @@ declare class FullScreenExitHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ exitFullScreen(): void; } @@ -1205,7 +1302,8 @@ declare class FullScreenExitHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FullScreenEnterEvent { /** @@ -1223,10 +1321,10 @@ declare interface FullScreenEnterEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: FullScreenExitHandler; - /** * The intrinsic width of the video if the fullscreen element contains video element, expressed in CSS pixels. * @@ -1242,10 +1340,10 @@ declare interface FullScreenEnterEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ videoWidth?: number; - /** * The intrinsic height of the video if the fullscreen element contains video element, expressed in CSS pixels. * @@ -1261,7 +1359,8 @@ declare interface FullScreenEnterEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ videoHeight?: number; } @@ -1283,7 +1382,8 @@ declare interface FullScreenEnterEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnFullScreenEnterCallback = (event: FullScreenEnterEvent) => void; @@ -1300,7 +1400,8 @@ type OnFullScreenEnterCallback = (event: FullScreenEnterEvent) => void; * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RenderExitReason { /** @@ -1314,7 +1415,8 @@ declare enum RenderExitReason { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ProcessAbnormalTermination = 0, @@ -1329,7 +1431,8 @@ declare enum RenderExitReason { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ProcessWasKilled = 1, @@ -1344,7 +1447,8 @@ declare enum RenderExitReason { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ProcessCrashed = 2, @@ -1359,7 +1463,8 @@ declare enum RenderExitReason { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ProcessOom = 3, @@ -1374,7 +1479,8 @@ declare enum RenderExitReason { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ProcessExitUnknown = 4 } @@ -1385,7 +1491,8 @@ declare enum RenderExitReason { * @typedef { function } OnContextMenuHideCallback * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type OnContextMenuHideCallback = () => void; @@ -1402,7 +1509,8 @@ type OnContextMenuHideCallback = () => void; * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum SslError { /** @@ -1416,7 +1524,8 @@ declare enum SslError { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Invalid = 0, @@ -1431,7 +1540,8 @@ declare enum SslError { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ HostMismatch = 1, @@ -1446,7 +1556,8 @@ declare enum SslError { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DateInvalid = 2, @@ -1461,7 +1572,8 @@ declare enum SslError { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Untrusted = 3 } @@ -1480,7 +1592,8 @@ declare enum SslError { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum FileSelectorMode { /** @@ -1495,7 +1608,8 @@ declare enum FileSelectorMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FileOpenMode = 0, @@ -1511,7 +1625,8 @@ declare enum FileSelectorMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FileOpenMultipleMode = 1, @@ -1527,7 +1642,8 @@ declare enum FileSelectorMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FileOpenFolderMode = 2, @@ -1543,7 +1659,8 @@ declare enum FileSelectorMode { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FileSaveMode = 3 } @@ -1554,7 +1671,8 @@ declare enum FileSelectorMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebLayoutMode { /** @@ -1562,7 +1680,8 @@ declare enum WebLayoutMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -1571,7 +1690,8 @@ declare enum WebLayoutMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FIT_CONTENT = 1 } @@ -1581,14 +1701,16 @@ declare enum WebLayoutMode { * * @enum { number } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RenderProcessNotRespondingReason { /** * Timeout for input sent to render process. * * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INPUT_TIMEOUT = 0, @@ -1596,7 +1718,8 @@ declare enum RenderProcessNotRespondingReason { * Timeout for navigation commit. * * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION_COMMIT_TIMEOUT = 1 } @@ -1613,7 +1736,8 @@ declare enum RenderProcessNotRespondingReason { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class FileSelectorParam { /** @@ -1628,7 +1752,8 @@ declare class FileSelectorParam { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1644,7 +1769,8 @@ declare class FileSelectorParam { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getTitle(): string; @@ -1660,7 +1786,8 @@ declare class FileSelectorParam { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getMode(): FileSelectorMode; @@ -1676,7 +1803,8 @@ declare class FileSelectorParam { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAcceptType(): Array; @@ -1694,7 +1822,8 @@ declare class FileSelectorParam { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isCapture(): boolean; @@ -1702,7 +1831,8 @@ declare class FileSelectorParam { * Gets an array of raw acceptable MIME type. * @returns { Array } Return an array of raw acceptable MIME type. * @syscap SystemCapability.Web.Webview.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getMimeTypes(): Array; } @@ -1719,7 +1849,8 @@ declare class FileSelectorParam { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class JsResult { /** @@ -1734,7 +1865,8 @@ declare class JsResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1750,7 +1882,8 @@ declare class JsResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ handleCancel(): void; @@ -1766,7 +1899,8 @@ declare class JsResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ handleConfirm(): void; @@ -1784,7 +1918,8 @@ declare class JsResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ handlePromptConfirm(result: string): void; } @@ -1801,7 +1936,8 @@ declare class JsResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class FileSelectorResult { /** @@ -1816,7 +1952,8 @@ declare class FileSelectorResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1834,7 +1971,8 @@ declare class FileSelectorResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ handleFileList(fileList: Array): void; } @@ -1851,7 +1989,8 @@ declare class FileSelectorResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class HttpAuthHandler { /** @@ -1866,7 +2005,8 @@ declare class HttpAuthHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1888,7 +2028,8 @@ declare class HttpAuthHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ confirm(userName: string, password: string): boolean; @@ -1904,7 +2045,8 @@ declare class HttpAuthHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ cancel(): void; @@ -1922,7 +2064,8 @@ declare class HttpAuthHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isHttpAuthInfoSaved(): boolean; } @@ -1938,7 +2081,8 @@ declare class HttpAuthHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class SslErrorHandler { /** @@ -1952,7 +2096,8 @@ declare class SslErrorHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1967,7 +2112,8 @@ declare class SslErrorHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ handleConfirm(): void; @@ -1982,7 +2128,8 @@ declare class SslErrorHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ handleCancel(): void; } @@ -1998,7 +2145,8 @@ declare class SslErrorHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class ClientAuthenticationHandler { /** @@ -2012,7 +2160,8 @@ declare class ClientAuthenticationHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2031,7 +2180,8 @@ declare class ClientAuthenticationHandler { * @param { string } certChainFile - The file that store client certificate chain. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ confirm(priKeyFile: string, certChainFile: string): void; @@ -2048,7 +2198,8 @@ declare class ClientAuthenticationHandler { * @param { string } authUri is the key of credentials.The credentials contain sign info and client certificates info. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ confirm(authUri: string): void; @@ -2063,7 +2214,8 @@ declare class ClientAuthenticationHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ cancel(): void; @@ -2078,7 +2230,8 @@ declare class ClientAuthenticationHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ignore(): void; } @@ -2097,7 +2250,8 @@ declare class ClientAuthenticationHandler { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ProtectedResourceType { /** @@ -2111,7 +2265,8 @@ declare enum ProtectedResourceType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MidiSysex = 'TYPE_MIDI_SYSEX', @@ -2127,7 +2282,8 @@ declare enum ProtectedResourceType { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_CAPTURE = 'TYPE_VIDEO_CAPTURE', @@ -2143,7 +2299,8 @@ declare enum ProtectedResourceType { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_CAPTURE = 'TYPE_AUDIO_CAPTURE', @@ -2152,7 +2309,8 @@ declare enum ProtectedResourceType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SENSOR = 'TYPE_SENSOR' } @@ -2169,7 +2327,8 @@ declare enum ProtectedResourceType { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class PermissionRequest { /** @@ -2184,7 +2343,8 @@ declare class PermissionRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2200,7 +2360,8 @@ declare class PermissionRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ deny(): void; @@ -2218,7 +2379,8 @@ declare class PermissionRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getOrigin(): string; @@ -2236,7 +2398,8 @@ declare class PermissionRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAccessibleResource(): Array; @@ -2254,7 +2417,8 @@ declare class PermissionRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ grant(resources: Array): void; } @@ -2268,7 +2432,8 @@ declare class PermissionRequest { * Defines the onScreenCapture callback, related to {@link onScreenCapture} method. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class ScreenCaptureHandler { /** @@ -2280,7 +2445,8 @@ declare class ScreenCaptureHandler { * Constructor. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2297,7 +2463,8 @@ declare class ScreenCaptureHandler { * @returns { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getOrigin(): string; @@ -2312,7 +2479,8 @@ declare class ScreenCaptureHandler { * @param { ScreenCaptureConfig } config The screen capture configuration. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ grant(config: ScreenCaptureConfig): void; @@ -2325,7 +2493,8 @@ declare class ScreenCaptureHandler { * Reject the request. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ deny(): void; } @@ -2341,7 +2510,8 @@ declare class ScreenCaptureHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class DataResubmissionHandler { /** @@ -2355,7 +2525,8 @@ declare class DataResubmissionHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2370,7 +2541,8 @@ declare class DataResubmissionHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ resend(): void; @@ -2385,7 +2557,8 @@ declare class DataResubmissionHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ cancel(): void; } @@ -2401,7 +2574,8 @@ declare class DataResubmissionHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class ControllerHandler { /** @@ -2415,7 +2589,8 @@ declare class ControllerHandler { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2432,7 +2607,8 @@ declare class ControllerHandler { * @param { WebviewController } controller * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ setWebController(controller: WebviewController): void; } @@ -2450,7 +2626,8 @@ declare class ControllerHandler { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ContextMenuSourceType { /** @@ -2464,7 +2641,8 @@ declare enum ContextMenuSourceType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ None = 0, @@ -2479,7 +2657,8 @@ declare enum ContextMenuSourceType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Mouse = 1, @@ -2494,7 +2673,8 @@ declare enum ContextMenuSourceType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LongPress = 2 } @@ -2512,7 +2692,8 @@ declare enum ContextMenuSourceType { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ContextMenuMediaType { /** @@ -2526,7 +2707,8 @@ declare enum ContextMenuMediaType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ None = 0, @@ -2541,7 +2723,8 @@ declare enum ContextMenuMediaType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Image = 1 } @@ -2559,7 +2742,8 @@ declare enum ContextMenuMediaType { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ContextMenuInputFieldType { /** @@ -2573,7 +2757,8 @@ declare enum ContextMenuInputFieldType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ None = 0, @@ -2588,7 +2773,8 @@ declare enum ContextMenuInputFieldType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PlainText = 1, @@ -2603,7 +2789,8 @@ declare enum ContextMenuInputFieldType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Password = 2, @@ -2618,7 +2805,8 @@ declare enum ContextMenuInputFieldType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Number = 3, @@ -2633,7 +2821,8 @@ declare enum ContextMenuInputFieldType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Telephone = 4, @@ -2648,7 +2837,8 @@ declare enum ContextMenuInputFieldType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Other = 5 } @@ -2659,7 +2849,8 @@ declare enum ContextMenuInputFieldType { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum NativeEmbedStatus { /** @@ -2667,7 +2858,8 @@ declare enum NativeEmbedStatus { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CREATE = 0, @@ -2676,7 +2868,8 @@ declare enum NativeEmbedStatus { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UPDATE = 1, @@ -2685,7 +2878,8 @@ declare enum NativeEmbedStatus { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DESTROY = 2, @@ -2694,7 +2888,8 @@ declare enum NativeEmbedStatus { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTER_BFCACHE = 3, @@ -2703,7 +2898,8 @@ declare enum NativeEmbedStatus { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LEAVE_BFCACHE = 4 } @@ -2721,7 +2917,8 @@ declare enum NativeEmbedStatus { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ContextMenuEditStateFlags { /** @@ -2735,7 +2932,8 @@ declare enum ContextMenuEditStateFlags { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -2750,7 +2948,8 @@ declare enum ContextMenuEditStateFlags { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CAN_CUT = 1 << 0, @@ -2765,7 +2964,8 @@ declare enum ContextMenuEditStateFlags { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CAN_COPY = 1 << 1, @@ -2780,7 +2980,8 @@ declare enum ContextMenuEditStateFlags { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CAN_PASTE = 1 << 2, @@ -2795,7 +2996,8 @@ declare enum ContextMenuEditStateFlags { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CAN_SELECT_ALL = 1 << 3 } @@ -2806,7 +3008,8 @@ declare enum ContextMenuEditStateFlags { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebNavigationType { /** @@ -2814,7 +3017,8 @@ declare enum WebNavigationType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, @@ -2826,7 +3030,8 @@ declare enum WebNavigationType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MAIN_FRAME_NEW_ENTRY = 1, @@ -2839,7 +3044,8 @@ declare enum WebNavigationType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MAIN_FRAME_EXISTING_ENTRY = 2, @@ -2848,7 +3054,8 @@ declare enum WebNavigationType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION_TYPE_NEW_SUBFRAME = 4, @@ -2857,7 +3064,8 @@ declare enum WebNavigationType { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION_TYPE_AUTO_SUBFRAME = 5 } @@ -2868,7 +3076,8 @@ declare enum WebNavigationType { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum RenderMode { /** @@ -2876,7 +3085,8 @@ declare enum RenderMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASYNC_RENDER = 0, @@ -2885,7 +3095,8 @@ declare enum RenderMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_RENDER = 1 } @@ -2896,7 +3107,8 @@ declare enum RenderMode { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum ViewportFit { /** @@ -2904,7 +3116,8 @@ declare enum ViewportFit { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -2914,7 +3127,8 @@ declare enum ViewportFit { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTAINS = 1, @@ -2924,7 +3138,8 @@ declare enum ViewportFit { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COVER = 2 } @@ -2940,7 +3155,8 @@ declare enum ViewportFit { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebContextMenuParam { /** @@ -2954,7 +3170,8 @@ declare class WebContextMenuParam { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2971,7 +3188,8 @@ declare class WebContextMenuParam { * @returns { number } The context menu x coordinate. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ x(): number; @@ -2988,7 +3206,8 @@ declare class WebContextMenuParam { * @returns { number } The context menu y coordinate. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ y(): number; @@ -3005,7 +3224,8 @@ declare class WebContextMenuParam { * @returns { string } If relate to a link return link url, else return null. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getLinkUrl(): string; @@ -3022,7 +3242,8 @@ declare class WebContextMenuParam { * @returns { string } If relate to a link return unfiltered link url, else return null. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getUnfilteredLinkUrl(): string; @@ -3039,7 +3260,8 @@ declare class WebContextMenuParam { * @returns { string } If this context menu is "src" attribute, return link url, else return null. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getSourceUrl(): string; @@ -3056,7 +3278,8 @@ declare class WebContextMenuParam { * @returns { boolean } Return whether this context menu has image content. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ existsImageContents(): boolean; @@ -3073,7 +3296,8 @@ declare class WebContextMenuParam { * @returns { ContextMenuMediaType } Returns the type of context node. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getMediaType(): ContextMenuMediaType; @@ -3090,7 +3314,8 @@ declare class WebContextMenuParam { * @returns { string } Returns the text of the selection. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getSelectionText(): string; @@ -3107,7 +3332,8 @@ declare class WebContextMenuParam { * @returns { ContextMenuSourceType } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getSourceType(): ContextMenuSourceType; @@ -3124,7 +3350,8 @@ declare class WebContextMenuParam { * @returns { ContextMenuInputFieldType } Input field type if the context menu was invoked on an input field. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getInputFieldType(): ContextMenuInputFieldType; @@ -3141,7 +3368,8 @@ declare class WebContextMenuParam { * @returns { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isEditable(): boolean; @@ -3158,7 +3386,8 @@ declare class WebContextMenuParam { * @returns { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getEditStateFlags(): number; @@ -3167,7 +3396,8 @@ declare class WebContextMenuParam { * * @returns { number } The preview menu width. * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ getPreviewWidth(): number; @@ -3176,7 +3406,8 @@ declare class WebContextMenuParam { * * @returns { number } The preview menu height. * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ getPreviewHeight(): number; } @@ -3192,7 +3423,8 @@ declare class WebContextMenuParam { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebContextMenuResult { /** @@ -3206,7 +3438,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3223,7 +3456,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ closeContextMenu(): void; @@ -3240,7 +3474,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ copyImage(): void; @@ -3255,7 +3490,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ copy(): void; @@ -3270,7 +3506,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ paste(): void; @@ -3285,7 +3522,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ cut(): void; @@ -3300,7 +3538,8 @@ declare class WebContextMenuResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ selectAll(): void; } @@ -3317,7 +3556,8 @@ declare class WebContextMenuResult { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class ConsoleMessage { /** @@ -3346,7 +3586,8 @@ declare class ConsoleMessage { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3364,7 +3605,8 @@ declare class ConsoleMessage { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getMessage(): string; @@ -3390,7 +3632,8 @@ declare class ConsoleMessage { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getSourceId(): string; @@ -3416,7 +3659,8 @@ declare class ConsoleMessage { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getLineNumber(): number; @@ -3434,7 +3678,8 @@ declare class ConsoleMessage { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getMessageLevel(): MessageLevel; } @@ -3464,7 +3709,8 @@ declare class ConsoleMessage { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebResourceRequest { /** @@ -3486,7 +3732,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3512,7 +3759,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getRequestHeader(): Array
; @@ -3538,7 +3786,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getRequestUrl(): string; @@ -3564,7 +3813,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ isRequestGesture(): boolean; @@ -3590,7 +3840,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ isMainFrame(): boolean; @@ -3616,7 +3867,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ isRedirect(): boolean; @@ -3642,7 +3894,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getRequestMethod(): string; } @@ -3659,7 +3912,8 @@ declare class WebResourceRequest { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebResourceResponse { /** @@ -3674,7 +3928,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3700,7 +3955,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseData(): string; @@ -3725,7 +3981,8 @@ declare class WebResourceResponse { * ArrayBuffer type indicate binary data. * @syscap SystemCapability.Web.Webview.Core * @crossplatform - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseDataEx(): string | number | ArrayBuffer | Resource | undefined; @@ -3743,7 +4000,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseEncoding(): string; @@ -3761,7 +4019,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseMimeType(): string; @@ -3787,7 +4046,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getReasonMessage(): string; @@ -3813,7 +4073,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseHeader(): Array
; @@ -3831,7 +4092,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseCode(): number; @@ -3862,7 +4124,8 @@ declare class WebResourceResponse { * ArrayBuffer type indicate binary data. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ setResponseData(data: string | number | Resource | ArrayBuffer): void; @@ -3887,7 +4150,8 @@ declare class WebResourceResponse { * @param { string } encoding the response encoding. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setResponseEncoding(encoding: string): void; @@ -3912,7 +4176,8 @@ declare class WebResourceResponse { * @param { string } mimeType the response MIME type. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setResponseMimeType(mimeType: string): void; @@ -3937,7 +4202,8 @@ declare class WebResourceResponse { * @param { string } reason the reason message. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setReasonMessage(reason: string): void; @@ -3962,7 +4228,8 @@ declare class WebResourceResponse { * @param { Array
} header the response headers. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setResponseHeader(header: Array
): void; @@ -3987,7 +4254,8 @@ declare class WebResourceResponse { * @param { number } code the response code. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setResponseCode(code: number): void; @@ -4012,7 +4280,8 @@ declare class WebResourceResponse { * @param { boolean } IsReady whether the response is ready. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setResponseIsReady(IsReady: boolean): void; @@ -4029,7 +4298,8 @@ declare class WebResourceResponse { * @returns { boolean } True indicates the response data is ready and false is not ready. * @syscap SystemCapability.Web.Webview.Core * @crossplatform - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ getResponseIsReady(): boolean; } @@ -4064,7 +4334,8 @@ declare class WebResourceResponse { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface Header { /** @@ -4089,7 +4360,8 @@ declare interface Header { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ headerKey: string; @@ -4115,7 +4387,8 @@ declare interface Header { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ headerValue: string; } @@ -4139,7 +4412,8 @@ declare interface Header { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebResourceError { /** @@ -4161,7 +4435,8 @@ declare class WebResourceError { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -4187,7 +4462,8 @@ declare class WebResourceError { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getErrorInfo(): string; @@ -4213,7 +4489,8 @@ declare class WebResourceError { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getErrorCode(): number; } @@ -4230,7 +4507,8 @@ declare class WebResourceError { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class JsGeolocation { /** @@ -4245,7 +4523,8 @@ declare class JsGeolocation { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -4267,7 +4546,8 @@ declare class JsGeolocation { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ invoke(origin: string, allow: boolean, retain: boolean): void; } @@ -4327,7 +4607,8 @@ declare class WebCookie { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class EventResult { /** @@ -4335,7 +4616,8 @@ declare class EventResult { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -4345,7 +4627,8 @@ declare class EventResult { * @param { boolean } result - True if the event is consumed. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setGestureEventResult(result: boolean): void; @@ -4355,7 +4638,8 @@ declare class EventResult { * @param { boolean } result - True if the event is consumed. * @param { boolean } stopPropagation - Stops the propagation of events farther along.Default value is true. * @syscap SystemCapability.Web.Webview.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ setGestureEventResult(result: boolean, stopPropagation: boolean): void; } @@ -4612,7 +4896,8 @@ declare class WebController { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface WebOptions { /** @@ -4637,7 +4922,8 @@ declare interface WebOptions { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ src: string | Resource; @@ -4674,13 +4960,26 @@ declare interface WebOptions { */ controller: WebController | WebviewController; + /** + * Sets the controller of the Web. + * + * @type { WebviewController } + * @syscap SystemCapability.Web.Webview.Core + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + controller: WebviewController; + /** * Sets the render mode of the web. * * @type { ?RenderMode } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ renderMode? : RenderMode; @@ -4703,7 +5002,8 @@ declare interface WebOptions { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ incognitoMode? : boolean; @@ -4716,7 +5016,8 @@ declare interface WebOptions { * * @type { ?string } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ sharedRenderProcessToken? : string; } @@ -4735,7 +5036,8 @@ declare interface WebOptions { * @typedef ScriptItem * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface ScriptItem { /** @@ -4744,7 +5046,8 @@ declare interface ScriptItem { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ script: string; @@ -4754,7 +5057,8 @@ declare interface ScriptItem { * @type { Array } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scriptRules: Array; } @@ -4773,7 +5077,8 @@ declare interface ScriptItem { * @typedef LoadCommittedDetails * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LoadCommittedDetails { /** @@ -4782,7 +5087,8 @@ declare interface LoadCommittedDetails { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isMainFrame: boolean; @@ -4796,7 +5102,8 @@ declare interface LoadCommittedDetails { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isSameDocument: boolean; @@ -4808,7 +5115,8 @@ declare interface LoadCommittedDetails { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ didReplaceEntry: boolean; @@ -4818,7 +5126,8 @@ declare interface LoadCommittedDetails { * @type { WebNavigationType } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ navigationType: WebNavigationType; @@ -4828,7 +5137,8 @@ declare interface LoadCommittedDetails { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; } @@ -4839,7 +5149,8 @@ declare interface LoadCommittedDetails { * @typedef IntelligentTrackingPreventionDetails * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface IntelligentTrackingPreventionDetails { /** @@ -4848,7 +5159,8 @@ declare interface IntelligentTrackingPreventionDetails { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ host: string; @@ -4858,7 +5170,8 @@ declare interface IntelligentTrackingPreventionDetails { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ trackerHost: string; } @@ -4894,36 +5207,38 @@ declare interface IntelligentTrackingPreventionDetails { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface WebInterface { /** - * Sets Value. - * - * @param { WebOptions } value - * @returns { WebAttribute } - * @syscap SystemCapability.Web.Webview.Core - * @since 8 - */ - /** - * Sets Value. - * - * @param { WebOptions } value - * @returns { WebAttribute } - * @syscap SystemCapability.Web.Webview.Core - * @crossplatform - * @since 10 - */ - /** - * Sets Value. - * - * @param { WebOptions } value - * @returns { WebAttribute } - * @syscap SystemCapability.Web.Webview.Core - * @crossplatform - * @atomicservice - * @since 11 - */ + * Sets Value. + * + * @param { WebOptions } value + * @returns { WebAttribute } + * @syscap SystemCapability.Web.Webview.Core + * @since 8 + */ + /** + * Sets Value. + * + * @param { WebOptions } value + * @returns { WebAttribute } + * @syscap SystemCapability.Web.Webview.Core + * @crossplatform + * @since 10 + */ + /** + * Sets Value. + * + * @param { WebOptions } value + * @returns { WebAttribute } + * @syscap SystemCapability.Web.Webview.Core + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 + */ (value: WebOptions): WebAttribute; } @@ -4941,7 +5256,8 @@ interface WebInterface { * @typedef NativeEmbedInfo * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NativeEmbedInfo { /** @@ -4950,7 +5266,8 @@ declare interface NativeEmbedInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ id?: string; @@ -4960,7 +5277,8 @@ declare interface NativeEmbedInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type?: string; @@ -4970,7 +5288,8 @@ declare interface NativeEmbedInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ src?: string; @@ -4980,7 +5299,8 @@ declare interface NativeEmbedInfo { * @type { ?Position } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ position?: Position; @@ -4990,7 +5310,8 @@ declare interface NativeEmbedInfo { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ width?: number; @@ -5000,7 +5321,8 @@ declare interface NativeEmbedInfo { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ height?: number; @@ -5010,7 +5332,8 @@ declare interface NativeEmbedInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ url?: string; @@ -5020,7 +5343,8 @@ declare interface NativeEmbedInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ tag?: string; @@ -5030,7 +5354,8 @@ declare interface NativeEmbedInfo { * @type { ?Map } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ params?: Map; } @@ -5049,7 +5374,8 @@ declare interface NativeEmbedInfo { * @typedef NativeEmbedDataInfo * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NativeEmbedDataInfo { /** @@ -5058,7 +5384,8 @@ declare interface NativeEmbedDataInfo { * @type { ?NativeEmbedStatus } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ status?: NativeEmbedStatus; @@ -5068,7 +5395,8 @@ declare interface NativeEmbedDataInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ surfaceId?: string; @@ -5078,7 +5406,8 @@ declare interface NativeEmbedDataInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ embedId?: string; @@ -5088,7 +5417,8 @@ declare interface NativeEmbedDataInfo { * @type { ?NativeEmbedInfo } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ info?: NativeEmbedInfo; } @@ -5098,7 +5428,8 @@ declare interface NativeEmbedDataInfo { * * @typedef NativeEmbedVisibilityInfo * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NativeEmbedVisibilityInfo { /** @@ -5106,7 +5437,8 @@ declare interface NativeEmbedVisibilityInfo { * * @type { boolean } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ visibility: boolean; @@ -5115,7 +5447,8 @@ declare interface NativeEmbedVisibilityInfo { * * @type { string } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ embedId: string; } @@ -5134,7 +5467,8 @@ declare interface NativeEmbedVisibilityInfo { * @typedef NativeEmbedTouchInfo * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NativeEmbedTouchInfo { /** @@ -5143,7 +5477,8 @@ declare interface NativeEmbedTouchInfo { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ embedId?: string; @@ -5153,7 +5488,8 @@ declare interface NativeEmbedTouchInfo { * @type { ?TouchEvent } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ touchEvent?: TouchEvent; @@ -5163,7 +5499,8 @@ declare interface NativeEmbedTouchInfo { * @type { ?EventResult } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ result?: EventResult; } @@ -5174,7 +5511,8 @@ declare interface NativeEmbedTouchInfo { * @typedef FirstMeaningfulPaint * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface FirstMeaningfulPaint { /** @@ -5183,7 +5521,8 @@ declare interface FirstMeaningfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ navigationStartTime?: number; @@ -5193,7 +5532,8 @@ declare interface FirstMeaningfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ firstMeaningfulPaintTime?: number; } @@ -5204,7 +5544,8 @@ declare interface FirstMeaningfulPaint { * @typedef LargestContentfulPaint * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface LargestContentfulPaint { /** @@ -5213,7 +5554,8 @@ declare interface LargestContentfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ navigationStartTime?: number; @@ -5223,7 +5565,8 @@ declare interface LargestContentfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ largestImagePaintTime?: number; @@ -5233,7 +5576,8 @@ declare interface LargestContentfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ largestTextPaintTime?: number; @@ -5243,7 +5587,8 @@ declare interface LargestContentfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ imageBPP?: number; @@ -5253,7 +5598,8 @@ declare interface LargestContentfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ largestImageLoadStartTime?: number; @@ -5263,7 +5609,8 @@ declare interface LargestContentfulPaint { * @type { ?number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ largestImageLoadEndTime?: number; } @@ -5273,7 +5620,8 @@ declare interface LargestContentfulPaint { * * @interface RenderProcessNotRespondingData * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface RenderProcessNotRespondingData { /** @@ -5281,7 +5629,8 @@ declare interface RenderProcessNotRespondingData { * * @type { string } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ jsStack: string; @@ -5290,7 +5639,8 @@ declare interface RenderProcessNotRespondingData { * * @type { number } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ pid: number; @@ -5299,7 +5649,8 @@ declare interface RenderProcessNotRespondingData { * * @type { RenderProcessNotRespondingReason } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ reason: RenderProcessNotRespondingReason; } @@ -5311,7 +5662,8 @@ declare interface RenderProcessNotRespondingData { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnPageEndEvent { /** @@ -5321,7 +5673,8 @@ declare interface OnPageEndEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; } @@ -5333,7 +5686,8 @@ declare interface OnPageEndEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnPageBeginEvent { /** @@ -5343,7 +5697,8 @@ declare interface OnPageBeginEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; } @@ -5355,7 +5710,8 @@ declare interface OnPageBeginEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnProgressChangeEvent { /** @@ -5365,7 +5721,8 @@ declare interface OnProgressChangeEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ newProgress: number; } @@ -5377,7 +5734,8 @@ declare interface OnProgressChangeEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnTitleReceiveEvent { /** @@ -5387,7 +5745,8 @@ declare interface OnTitleReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ title: string; } @@ -5399,7 +5758,8 @@ declare interface OnTitleReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnGeolocationShowEvent { /** @@ -5409,7 +5769,8 @@ declare interface OnGeolocationShowEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ origin: string; @@ -5420,7 +5781,8 @@ declare interface OnGeolocationShowEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ geolocation: JsGeolocation; } @@ -5432,7 +5794,8 @@ declare interface OnGeolocationShowEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnAlertEvent { /** @@ -5442,7 +5805,8 @@ declare interface OnAlertEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -5453,7 +5817,8 @@ declare interface OnAlertEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ message: string; @@ -5464,7 +5829,8 @@ declare interface OnAlertEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ result: JsResult; } @@ -5484,7 +5850,8 @@ declare interface OnAlertEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnBeforeUnloadEvent { /** @@ -5502,7 +5869,8 @@ declare interface OnBeforeUnloadEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -5521,7 +5889,8 @@ declare interface OnBeforeUnloadEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ message: string; @@ -5540,7 +5909,8 @@ declare interface OnBeforeUnloadEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ result: JsResult; } @@ -5552,7 +5922,8 @@ declare interface OnBeforeUnloadEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnConfirmEvent { /** @@ -5562,7 +5933,8 @@ declare interface OnConfirmEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -5573,7 +5945,8 @@ declare interface OnConfirmEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ message: string; @@ -5584,7 +5957,8 @@ declare interface OnConfirmEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ result: JsResult; } @@ -5596,7 +5970,8 @@ declare interface OnConfirmEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnPromptEvent { /** @@ -5606,7 +5981,8 @@ declare interface OnPromptEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -5617,7 +5993,8 @@ declare interface OnPromptEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ message: string; @@ -5628,7 +6005,8 @@ declare interface OnPromptEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ value: string; @@ -5639,7 +6017,8 @@ declare interface OnPromptEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ result: JsResult; } @@ -5651,7 +6030,8 @@ declare interface OnPromptEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnConsoleEvent { /** @@ -5661,7 +6041,8 @@ declare interface OnConsoleEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ message: ConsoleMessage; } @@ -5673,7 +6054,8 @@ declare interface OnConsoleEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnErrorReceiveEvent { /** @@ -5683,7 +6065,8 @@ declare interface OnErrorReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ request: WebResourceRequest; @@ -5694,7 +6077,8 @@ declare interface OnErrorReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ error: WebResourceError; } @@ -5706,7 +6090,8 @@ declare interface OnErrorReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnHttpErrorReceiveEvent { /** @@ -5716,7 +6101,8 @@ declare interface OnHttpErrorReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ request: WebResourceRequest; @@ -5727,7 +6113,8 @@ declare interface OnHttpErrorReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ response: WebResourceResponse; } @@ -5739,7 +6126,8 @@ declare interface OnHttpErrorReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnDownloadStartEvent { /** @@ -5749,7 +6137,8 @@ declare interface OnDownloadStartEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -5760,7 +6149,8 @@ declare interface OnDownloadStartEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ userAgent: string; @@ -5779,7 +6169,8 @@ declare interface OnDownloadStartEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ contentDisposition: string; @@ -5790,7 +6181,8 @@ declare interface OnDownloadStartEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ mimetype: string; @@ -5801,7 +6193,8 @@ declare interface OnDownloadStartEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ contentLength: number; } @@ -5821,7 +6214,8 @@ declare interface OnDownloadStartEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnRefreshAccessedHistoryEvent { /** @@ -5839,7 +6233,8 @@ declare interface OnRefreshAccessedHistoryEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -5858,7 +6253,8 @@ declare interface OnRefreshAccessedHistoryEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ isRefreshed: boolean; } @@ -5869,7 +6265,8 @@ declare interface OnRefreshAccessedHistoryEvent { * @typedef OnRenderExitedEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnRenderExitedEvent { /** @@ -5878,7 +6275,8 @@ declare interface OnRenderExitedEvent { * @type { RenderExitReason } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ renderExitReason: RenderExitReason; } @@ -5890,7 +6288,8 @@ declare interface OnRenderExitedEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnShowFileSelectorEvent { /** @@ -5900,7 +6299,8 @@ declare interface OnShowFileSelectorEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ result: FileSelectorResult; @@ -5911,7 +6311,8 @@ declare interface OnShowFileSelectorEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fileSelector: FileSelectorParam; } @@ -5922,7 +6323,8 @@ declare interface OnShowFileSelectorEvent { * @typedef OnResourceLoadEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnResourceLoadEvent { /** @@ -5931,7 +6333,8 @@ declare interface OnResourceLoadEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; } @@ -5943,7 +6346,8 @@ declare interface OnResourceLoadEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnScaleChangeEvent { /** @@ -5953,7 +6357,8 @@ declare interface OnScaleChangeEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ oldScale: number; @@ -5964,7 +6369,8 @@ declare interface OnScaleChangeEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ newScale: number; } @@ -5976,7 +6382,8 @@ declare interface OnScaleChangeEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnHttpAuthRequestEvent { /** @@ -5986,7 +6393,8 @@ declare interface OnHttpAuthRequestEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: HttpAuthHandler; @@ -5997,7 +6405,8 @@ declare interface OnHttpAuthRequestEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ host: string; @@ -6008,7 +6417,8 @@ declare interface OnHttpAuthRequestEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ realm: string; } @@ -6019,7 +6429,8 @@ declare interface OnHttpAuthRequestEvent { * @typedef OnInterceptRequestEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnInterceptRequestEvent { /** @@ -6028,7 +6439,8 @@ declare interface OnInterceptRequestEvent { * @type { WebResourceRequest } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ request: WebResourceRequest; } @@ -6041,7 +6453,8 @@ declare interface OnInterceptRequestEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnPermissionRequestEvent { /** @@ -6051,7 +6464,8 @@ declare interface OnPermissionRequestEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ request: PermissionRequest; } @@ -6063,7 +6477,8 @@ declare interface OnPermissionRequestEvent { * @typedef OnScreenCaptureRequestEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnScreenCaptureRequestEvent { /** @@ -6072,7 +6487,8 @@ declare interface OnScreenCaptureRequestEvent { * @type { ScreenCaptureHandler } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: ScreenCaptureHandler; } @@ -6083,7 +6499,8 @@ declare interface OnScreenCaptureRequestEvent { * @typedef OnContextMenuShowEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnContextMenuShowEvent { /** @@ -6092,7 +6509,8 @@ declare interface OnContextMenuShowEvent { * @type { WebContextMenuParam } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ param: WebContextMenuParam; @@ -6102,7 +6520,8 @@ declare interface OnContextMenuShowEvent { * @type { WebContextMenuResult } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ result: WebContextMenuResult; } @@ -6113,7 +6532,8 @@ declare interface OnContextMenuShowEvent { * @typedef OnSearchResultReceiveEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnSearchResultReceiveEvent { /** @@ -6122,7 +6542,8 @@ declare interface OnSearchResultReceiveEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ activeMatchOrdinal: number; @@ -6132,7 +6553,8 @@ declare interface OnSearchResultReceiveEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numberOfMatches: number; @@ -6142,7 +6564,8 @@ declare interface OnSearchResultReceiveEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isDoneCounting: boolean; } @@ -6154,7 +6577,8 @@ declare interface OnSearchResultReceiveEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnScrollEvent { /** @@ -6164,7 +6588,8 @@ declare interface OnScrollEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ xOffset: number; @@ -6175,7 +6600,8 @@ declare interface OnScrollEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ yOffset: number; } @@ -6186,7 +6612,8 @@ declare interface OnScrollEvent { * @typedef OnSslErrorEventReceiveEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnSslErrorEventReceiveEvent { /** @@ -6195,7 +6622,8 @@ declare interface OnSslErrorEventReceiveEvent { * @type { SslErrorHandler } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: SslErrorHandler; @@ -6205,7 +6633,8 @@ declare interface OnSslErrorEventReceiveEvent { * @type { SslError } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ error: SslError; @@ -6214,7 +6643,8 @@ declare interface OnSslErrorEventReceiveEvent { * * @type { ?Array } * @syscap SystemCapability.Web.Webview.Core - * @since 15 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ certChainData?: Array; } @@ -6225,7 +6655,8 @@ declare interface OnSslErrorEventReceiveEvent { * @typedef OnClientAuthenticationEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnClientAuthenticationEvent { /** @@ -6234,7 +6665,8 @@ declare interface OnClientAuthenticationEvent { * @type { ClientAuthenticationHandler } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler : ClientAuthenticationHandler; @@ -6244,7 +6676,8 @@ declare interface OnClientAuthenticationEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ host : string; @@ -6254,7 +6687,8 @@ declare interface OnClientAuthenticationEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ port : number; @@ -6264,7 +6698,8 @@ declare interface OnClientAuthenticationEvent { * @type { Array } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ keyTypes : Array; @@ -6274,7 +6709,8 @@ declare interface OnClientAuthenticationEvent { * @type { Array } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ issuers : Array; } @@ -6285,7 +6721,8 @@ declare interface OnClientAuthenticationEvent { * @typedef OnWindowNewEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnWindowNewEvent { /** @@ -6294,7 +6731,8 @@ declare interface OnWindowNewEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isAlert: boolean; @@ -6304,7 +6742,8 @@ declare interface OnWindowNewEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isUserTrigger: boolean; @@ -6314,7 +6753,8 @@ declare interface OnWindowNewEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ targetUrl: string; @@ -6324,7 +6764,8 @@ declare interface OnWindowNewEvent { * @type { ControllerHandler } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: ControllerHandler; } @@ -6335,7 +6776,8 @@ declare interface OnWindowNewEvent { * @typedef OnTouchIconUrlReceivedEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnTouchIconUrlReceivedEvent { /** @@ -6344,7 +6786,8 @@ declare interface OnTouchIconUrlReceivedEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -6354,7 +6797,8 @@ declare interface OnTouchIconUrlReceivedEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ precomposed: boolean; } @@ -6365,7 +6809,8 @@ declare interface OnTouchIconUrlReceivedEvent { * @typedef OnFaviconReceivedEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnFaviconReceivedEvent { /** @@ -6377,6 +6822,17 @@ declare interface OnFaviconReceivedEvent { * @since 12 */ favicon: PixelMap; + + /** + * Received the Favicon icon for the image.PixelMap object. + * + * @type { image.PixelMap } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + favicon: image.PixelMap; } /** @@ -6386,7 +6842,8 @@ declare interface OnFaviconReceivedEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnPageVisibleEvent { /** @@ -6396,7 +6853,8 @@ declare interface OnPageVisibleEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; } @@ -6407,7 +6865,8 @@ declare interface OnPageVisibleEvent { * @typedef OnDataResubmittedEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnDataResubmittedEvent { /** @@ -6416,7 +6875,8 @@ declare interface OnDataResubmittedEvent { * @type { DataResubmissionHandler } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: DataResubmissionHandler; } @@ -6427,7 +6887,8 @@ declare interface OnDataResubmittedEvent { * @typedef OnAudioStateChangedEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnAudioStateChangedEvent { /** @@ -6436,7 +6897,8 @@ declare interface OnAudioStateChangedEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ playing: boolean; } @@ -6447,7 +6909,8 @@ declare interface OnAudioStateChangedEvent { * @typedef OnFirstContentfulPaintEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnFirstContentfulPaintEvent { /** @@ -6456,7 +6919,8 @@ declare interface OnFirstContentfulPaintEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ navigationStartTick: number; @@ -6466,7 +6930,8 @@ declare interface OnFirstContentfulPaintEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ firstContentfulPaintMs: number; } @@ -6478,7 +6943,8 @@ declare interface OnFirstContentfulPaintEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnLoadInterceptEvent { /** @@ -6488,7 +6954,8 @@ declare interface OnLoadInterceptEvent { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ data: WebResourceRequest; } @@ -6499,7 +6966,8 @@ declare interface OnLoadInterceptEvent { * @typedef OnOverScrollEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface OnOverScrollEvent { /** @@ -6508,7 +6976,8 @@ declare interface OnOverScrollEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ xOffset: number; @@ -6518,7 +6987,8 @@ declare interface OnOverScrollEvent { * @type { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ yOffset: number; } @@ -6529,7 +6999,8 @@ declare interface OnOverScrollEvent { * @typedef JavaScriptProxy * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface JavaScriptProxy { /** @@ -6538,7 +7009,8 @@ declare interface JavaScriptProxy { * @type { object } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ object: object; @@ -6549,7 +7021,8 @@ declare interface JavaScriptProxy { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -6560,7 +7033,8 @@ declare interface JavaScriptProxy { * @type { Array } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ methodList: Array; @@ -6573,14 +7047,24 @@ declare interface JavaScriptProxy { * @since 12 */ controller: WebController | WebviewController; - + /** + * Controller. + * + * @type { WebviewController } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + controller: WebviewController; /** * The async method of the application side JavaScript object participating in the registration. * * @type { ?Array } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ asyncMethodList?: Array; @@ -6591,7 +7075,8 @@ declare interface JavaScriptProxy { * @type { ?string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ permission?: string; } @@ -6602,7 +7087,8 @@ declare interface JavaScriptProxy { * @enum { number } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebKeyboardAvoidMode { /** @@ -6610,7 +7096,8 @@ declare enum WebKeyboardAvoidMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_VISUAL = 0, @@ -6619,7 +7106,8 @@ declare enum WebKeyboardAvoidMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_CONTENT = 1, @@ -6628,7 +7116,8 @@ declare enum WebKeyboardAvoidMode { * * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OVERLAYS_CONTENT = 2 } @@ -6638,14 +7127,16 @@ declare enum WebKeyboardAvoidMode { * * @enum { number } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebElementType { /** * Image,corresponding HTML image type. * * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1 } @@ -6655,42 +7146,27 @@ declare enum WebElementType { * * @enum { number } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ declare enum WebResponseType { /** * Long press. * * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ LONG_PRESS = 1 } -/** - * Defines the options of preview menu - * - * @interface PreviewMenuOptions - * @syscap SystemCapability.Web.Webview.Core - * @since 18 - */ -declare interface PreviewMenuOptions { - /** - * Defines the haptic feedback mode of preview menu. - * - * @type { ?HapticFeedbackMode } - * @syscap SystemCapability.Web.Webview.Core - * @since 18 - */ - hapticFeedbackMode?: HapticFeedbackMode; -} - /** * Defines the selection menu options. * * @typedef SelectionMenuOptionsExt * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SelectionMenuOptionsExt { /** @@ -6698,7 +7174,8 @@ declare interface SelectionMenuOptionsExt { * * @type { ?Callback } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ onAppear?: Callback; @@ -6707,7 +7184,8 @@ declare interface SelectionMenuOptionsExt { * * @type { ?Callback } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ onDisappear?: Callback; @@ -6716,7 +7194,8 @@ declare interface SelectionMenuOptionsExt { * * @type { ?CustomBuilder } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ preview?: CustomBuilder; @@ -6725,18 +7204,10 @@ declare interface SelectionMenuOptionsExt { * * @type { ?MenuType } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ menuType?: MenuType; - - /** - * Defines the options of preview menu. - * - * @type { ?PreviewMenuOptions } - * @syscap SystemCapability.Web.Webview.Core - * @since 18 - */ - previewMenuOptions?: PreviewMenuOptions; } /** @@ -6761,7 +7232,8 @@ declare interface SelectionMenuOptionsExt { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare class WebAttribute extends CommonMethod { /** @@ -6792,7 +7264,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ javaScriptAccess(javaScriptAccess: boolean): WebAttribute; @@ -6823,7 +7296,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fileAccess(fileAccess: boolean): WebAttribute; @@ -6857,7 +7331,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onlineImageAccess(onlineImageAccess: boolean): WebAttribute; @@ -6888,7 +7363,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ domStorageAccess(domStorageAccess: boolean): WebAttribute; @@ -6919,7 +7395,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ imageAccess(imageAccess: boolean): WebAttribute; @@ -6948,7 +7425,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ mixedMode(mixedMode: MixedMode): WebAttribute; @@ -6980,7 +7458,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ zoomAccess(zoomAccess: boolean): WebAttribute; @@ -7002,7 +7481,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ geolocationAccess(geolocationAccess: boolean): WebAttribute; @@ -7038,7 +7518,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ javaScriptProxy(javaScriptProxy: JavaScriptProxy): WebAttribute; @@ -7078,7 +7559,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ cacheMode(cacheMode: CacheMode): WebAttribute; @@ -7097,7 +7579,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ darkMode(mode: WebDarkMode): WebAttribute; @@ -7116,7 +7599,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ forceDarkAccess(access: boolean): WebAttribute; @@ -7135,7 +7619,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ mediaOptions(options: WebMediaOptions): WebAttribute; @@ -7178,19 +7663,21 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ overviewModeAccess(overviewModeAccess: boolean): WebAttribute; /** - * Sets the over-scroll mode for web - * - * @param { OverScrollMode } mode - The over-scroll mode, which can be {@link OverScrollMode}. - * @returns { WebAttribute } - * @syscap SystemCapability.Web.Webview.Core - * @atomicservice - * @since 11 - */ + * Sets the over-scroll mode for web + * + * @param { OverScrollMode } mode - The over-scroll mode, which can be {@link OverScrollMode}. + * @returns { WebAttribute } + * @syscap SystemCapability.Web.Webview.Core + * @atomicservice + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 + */ overScrollMode(mode: OverScrollMode): WebAttribute; /** @@ -7200,7 +7687,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ blurOnKeyboardHideMode(mode: BlurOnKeyboardHideMode): WebAttribute; @@ -7231,7 +7719,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ textZoomRatio(textZoomRatio: number): WebAttribute; @@ -7252,7 +7741,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ databaseAccess(databaseAccess: boolean): WebAttribute; @@ -7271,7 +7761,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ initialScale(percent: number): WebAttribute; @@ -7294,7 +7785,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ metaViewport(enabled: boolean): WebAttribute; @@ -7333,7 +7825,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onPageEnd(callback: Callback): WebAttribute; @@ -7372,7 +7865,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onPageBegin(callback: Callback): WebAttribute; @@ -7402,7 +7896,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onProgressChange(callback: Callback): WebAttribute; @@ -7432,7 +7927,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onTitleReceive(callback: Callback): WebAttribute; @@ -7452,7 +7948,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onGeolocationHide(callback: () => void): WebAttribute; @@ -7482,7 +7979,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onGeolocationShow(callback: Callback): WebAttribute; @@ -7501,7 +7999,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onRequestSelected(callback: () => void): WebAttribute; @@ -7531,7 +8030,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onAlert(callback: Callback): WebAttribute; @@ -7569,7 +8069,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onBeforeUnload(callback: Callback): WebAttribute; @@ -7599,7 +8100,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onConfirm(callback: Callback): WebAttribute; @@ -7629,7 +8131,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onPrompt(callback: Callback): WebAttribute; @@ -7659,7 +8162,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onConsole(callback: Callback): WebAttribute; @@ -7698,7 +8202,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onErrorReceive(callback: Callback): WebAttribute; @@ -7728,7 +8233,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onHttpErrorReceive(callback: Callback): WebAttribute; @@ -7758,7 +8264,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onDownloadStart(callback: Callback): WebAttribute; @@ -7796,7 +8303,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onRefreshAccessedHistory(callback: Callback): WebAttribute; @@ -7848,7 +8356,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onRenderExited(callback: Callback): WebAttribute; @@ -7878,7 +8387,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onShowFileSelector(callback: Callback): WebAttribute; @@ -7930,7 +8440,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onResourceLoad(callback: Callback): WebAttribute; @@ -7959,7 +8470,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onFullScreenExit(callback: () => void): WebAttribute; @@ -7997,7 +8509,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ onFullScreenEnter(callback: OnFullScreenEnterCallback): WebAttribute; @@ -8027,7 +8540,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onScaleChange(callback: Callback): WebAttribute; @@ -8057,7 +8571,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onHttpAuthRequest(callback: Callback): WebAttribute; @@ -8085,7 +8600,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } If the response value is null, the Web will continue to load the resources. Otherwise, the response value will be used * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onInterceptRequest(callback: Callback): WebAttribute; @@ -8118,7 +8634,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onPermissionRequest(callback: Callback): WebAttribute; @@ -8146,7 +8663,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onScreenCaptureRequest(callback: Callback): WebAttribute; @@ -8174,7 +8692,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } If custom display return true.Otherwise, default display return false. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onContextMenuShow(callback: Callback): WebAttribute; @@ -8185,7 +8704,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onContextMenuHide(callback: OnContextMenuHideCallback): WebAttribute; @@ -8207,7 +8727,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ mediaPlayGestureAccess(access: boolean): WebAttribute; @@ -8238,7 +8759,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onSearchResultReceive(callback: Callback): WebAttribute; @@ -8268,7 +8790,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onScroll(callback: Callback): WebAttribute; @@ -8296,7 +8819,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onSslErrorEventReceive(callback: Callback): WebAttribute; @@ -8307,7 +8831,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onSslErrorEvent(callback: OnSslErrorEventCallback): WebAttribute; @@ -8335,7 +8860,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onClientAuthenticationRequest(callback: Callback): WebAttribute; @@ -8363,7 +8889,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowNew(callback: Callback): WebAttribute; @@ -8382,7 +8909,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowExit(callback: () => void): WebAttribute; @@ -8403,7 +8931,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ multiWindowAccess(multiWindow: boolean): WebAttribute; @@ -8422,7 +8951,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } True if the application consumes key events else false. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onInterceptKeyEvent(callback: (event: KeyEvent) => boolean): WebAttribute; @@ -8441,7 +8971,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ webStandardFont(family: string): WebAttribute; @@ -8460,7 +8991,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ webSerifFont(family: string): WebAttribute; @@ -8479,7 +9011,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ webSansSerifFont(family: string): WebAttribute; @@ -8498,7 +9031,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ webFixedFont(family: string): WebAttribute; @@ -8517,7 +9051,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ webFantasyFont(family: string): WebAttribute; @@ -8536,7 +9071,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ webCursiveFont(family: string): WebAttribute; @@ -8555,7 +9091,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ defaultFixedFontSize(size: number): WebAttribute; @@ -8574,7 +9111,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ defaultFontSize(size: number): WebAttribute; @@ -8594,7 +9132,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ minFontSize(size: number): WebAttribute; @@ -8613,7 +9152,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ minLogicalFontSize(size: number): WebAttribute; @@ -8624,7 +9164,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ defaultTextEncodingFormat(textEncodingFormat: string): WebAttribute; @@ -8635,7 +9176,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ forceDisplayScrollBar(enabled: boolean): WebAttribute; @@ -8664,7 +9206,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ blockNetwork(block: boolean): WebAttribute; @@ -8686,7 +9229,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ horizontalScrollBarAccess(horizontalScrollBar: boolean): WebAttribute; @@ -8708,7 +9252,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ verticalScrollBarAccess(verticalScrollBar: boolean): WebAttribute; @@ -8739,7 +9284,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onTouchIconUrlReceived(callback: Callback): WebAttribute; @@ -8770,7 +9316,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onFaviconReceived(callback: Callback): WebAttribute; @@ -8803,7 +9350,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onPageVisible(callback: Callback): WebAttribute; @@ -8831,7 +9379,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onDataResubmitted(callback: Callback): WebAttribute; @@ -8850,7 +9399,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ pinchSmooth(isEnabled: boolean): WebAttribute; @@ -8873,7 +9423,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ allowWindowOpenMethod(flag: boolean): WebAttribute; @@ -8901,7 +9452,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onAudioStateChanged(callback: Callback): WebAttribute; @@ -8929,7 +9481,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onFirstContentfulPaint(callback: Callback): WebAttribute; @@ -8940,7 +9493,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onFirstMeaningfulPaint(callback: OnFirstMeaningfulPaintCallback): WebAttribute; @@ -8951,7 +9505,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onLargestContentfulPaint(callback: OnLargestContentfulPaintCallback): WebAttribute; @@ -8981,7 +9536,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onLoadIntercept(callback: Callback): WebAttribute; @@ -9001,7 +9557,8 @@ declare class WebAttribute extends CommonMethod { * @syscap SystemCapability.Web.Webview.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onControllerAttached(callback: () => void): WebAttribute; @@ -9026,7 +9583,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onOverScroll(callback: Callback): WebAttribute; @@ -9037,7 +9595,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onSafeBrowsingCheckResult(callback: OnSafeBrowsingCheckResultCallback): WebAttribute; @@ -9048,7 +9607,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onNavigationEntryCommitted(callback: OnNavigationEntryCommittedCallback): WebAttribute; @@ -9059,7 +9619,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onIntelligentTrackingPreventionResult(callback: OnIntelligentTrackingPreventionCallback): WebAttribute; @@ -9069,7 +9630,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ javaScriptOnDocumentStart(scripts: Array): WebAttribute; @@ -9079,7 +9641,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ javaScriptOnDocumentEnd(scripts: Array): WebAttribute; @@ -9089,7 +9652,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ layoutMode(mode: WebLayoutMode): WebAttribute; @@ -9110,7 +9674,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } the attribute of the scroll. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ nestedScroll(value: NestedScrollOptions | NestedScrollOptionsExt): WebAttribute; @@ -9121,7 +9686,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enableNativeEmbedMode(mode: boolean): WebAttribute; @@ -9133,7 +9699,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ registerNativeEmbedRule(tag: string, type:string): WebAttribute; @@ -9144,7 +9711,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onNativeEmbedLifecycleChange(callback: (event: NativeEmbedDataInfo) => void): WebAttribute; @@ -9154,7 +9722,8 @@ declare class WebAttribute extends CommonMethod { * @param { OnNativeEmbedVisibilityChangeCallback } callback - Callback triggered when embed visibility changes. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onNativeEmbedVisibilityChange(callback: OnNativeEmbedVisibilityChangeCallback): WebAttribute; @@ -9165,7 +9734,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onNativeEmbedGestureEvent(callback: (event: NativeEmbedTouchInfo) => void): WebAttribute; @@ -9176,7 +9746,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } the attribute of the scroll. * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ copyOptions(value: CopyOptions): WebAttribute; @@ -9188,7 +9759,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onOverrideUrlLoading(callback: OnOverrideUrlLoadingCallback): WebAttribute; @@ -9199,7 +9771,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ textAutosizing(textAutosizing: boolean): WebAttribute; @@ -9210,7 +9783,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enableNativeMediaPlayer(config: NativeMediaPlayerConfig): WebAttribute; @@ -9220,7 +9794,8 @@ declare class WebAttribute extends CommonMethod { * @param { OnRenderProcessNotRespondingCallback } callback The triggered function when render process not responding. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onRenderProcessNotResponding(callback: OnRenderProcessNotRespondingCallback): WebAttribute; @@ -9230,7 +9805,8 @@ declare class WebAttribute extends CommonMethod { * @param { OnRenderProcessRespondingCallback } callback The triggered function when the unresponsive render process becomes responsive. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onRenderProcessResponding(callback: OnRenderProcessRespondingCallback): WebAttribute; @@ -9251,7 +9827,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onViewportFitChanged(callback: OnViewportFitChangedCallback): WebAttribute; @@ -9265,7 +9842,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onInterceptKeyboardAttach(callback: WebKeyboardCallback): WebAttribute; @@ -9278,7 +9856,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onAdsBlocked(callback: OnAdsBlockedCallback): WebAttribute; @@ -9289,7 +9868,8 @@ declare class WebAttribute extends CommonMethod { * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ keyboardAvoidMode(mode: WebKeyboardAvoidMode): WebAttribute; @@ -9299,7 +9879,8 @@ declare class WebAttribute extends CommonMethod { * @param { EditMenuOptions } editMenu - Customize text menu options. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ editMenuOptions(editMenu: EditMenuOptions): WebAttribute; @@ -9309,7 +9890,8 @@ declare class WebAttribute extends CommonMethod { * @param { boolean } enabled - Default value is true, set false to disable haptic feedback. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ enableHapticFeedback(enabled: boolean): WebAttribute; @@ -9322,40 +9904,44 @@ declare class WebAttribute extends CommonMethod { * @param { SelectionMenuOptionsExt } [options] - Indicates the options of selection menu. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ bindSelectionMenu(elementType: WebElementType, content: CustomBuilder, responseType: WebResponseType, options?: SelectionMenuOptionsExt): WebAttribute; /** - * Sets whether to follow the system font weight. + * Sets whether to optimize parser budget to reduce FCP time * - * @param { boolean } follow The value true means to follow the system font weight, and false means the opposite. + * @param { boolean} optimizeParserBudget Default value is false, set true to enable optimize parser budget. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 18 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ - enableFollowSystemFontWeight(follow: boolean): WebAttribute; + optimizeParserBudget(optimizeParserBudget: boolean): WebAttribute; /** - * Sets whether to enable AVSession for web pages. + * Sets whether to follow the system font weight. * - * @param { boolean } enabled Whether to enable AVSession. The value true means to enable AVSession, and false means the opposite. + * @param { boolean } follow The value true means to follow the system font weight, and false means the opposite. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - enableWebAVSession(enabled: boolean): WebAttribute; + enableFollowSystemFontWeight(follow: boolean): WebAttribute; /** - * Sets whether to optimize parser budget to reduce FCP time + * Sets whether to enable AVSession for web pages. * - * @param { boolean} optimizeParserBudget Default value is false, set true to enable optimize parser budget. + * @param { boolean } enabled Whether to enable AVSession. The value true means to enable AVSession, and false means the opposite. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 15 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - optimizeParserBudget(optimizeParserBudget: boolean): WebAttribute; + enableWebAVSession(enabled: boolean): WebAttribute; /** * Injects the JavaScripts that will be run just after document object has been created. @@ -9363,7 +9949,8 @@ declare class WebAttribute extends CommonMethod { * @param { Array } scripts - The JavaScripts executed in array order. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ runJavaScriptOnDocumentStart(scripts: Array): WebAttribute; @@ -9373,7 +9960,8 @@ declare class WebAttribute extends CommonMethod { * @param { Array } scripts - The JavaScripts executed in array order. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ runJavaScriptOnDocumentEnd(scripts: Array): WebAttribute; @@ -9383,7 +9971,8 @@ declare class WebAttribute extends CommonMethod { * @param { Array } scripts - The JavaScripts executed in array order. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ runJavaScriptOnHeadEnd(scripts: Array): WebAttribute; @@ -9393,7 +9982,8 @@ declare class WebAttribute extends CommonMethod { * @param { EmbedOptions } options The embed options, which can be {@link EmbedOptions}. * @returns { WebAttribute } * @syscap SystemCapability.Web.Webview.Core - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ nativeEmbedOptions(options?: EmbedOptions): WebAttribute; } @@ -9443,7 +10033,8 @@ declare const WebInstance: WebAttribute; * @typedef SslErrorEvent * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SslErrorEvent { /** @@ -9452,7 +10043,8 @@ declare interface SslErrorEvent { * @type { SslErrorHandler } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ handler: SslErrorHandler; @@ -9462,7 +10054,8 @@ declare interface SslErrorEvent { * @type { SslError } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ error: SslError; @@ -9472,7 +10065,8 @@ declare interface SslErrorEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -9482,7 +10076,8 @@ declare interface SslErrorEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ originalUrl: string; @@ -9492,7 +10087,8 @@ declare interface SslErrorEvent { * @type { string } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ referrer: string; @@ -9502,7 +10098,8 @@ declare interface SslErrorEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isFatalError: boolean; @@ -9512,7 +10109,8 @@ declare interface SslErrorEvent { * @type { boolean } * @syscap SystemCapability.Web.Webview.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isMainFrame: boolean; } @@ -9562,7 +10160,8 @@ declare interface ExpandedMenuItemOptions { * * @interface NestedScrollOptionsExt * @syscap SystemCapability.Web.Webview.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NestedScrollOptionsExt { /** @@ -9570,7 +10169,8 @@ declare interface NestedScrollOptionsExt { * * @type { ?NestedScrollMode } * @syscap SystemCapability.Web.Webview.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollUp?: NestedScrollMode; @@ -9579,7 +10179,8 @@ declare interface NestedScrollOptionsExt { * * @type { ?NestedScrollMode } * @syscap SystemCapability.Web.Webview.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollDown?: NestedScrollMode; @@ -9588,7 +10189,8 @@ declare interface NestedScrollOptionsExt { * * @type { ?NestedScrollMode } * @syscap SystemCapability.Web.Webview.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollRight?: NestedScrollMode; @@ -9597,7 +10199,8 @@ declare interface NestedScrollOptionsExt { * * @type { ?NestedScrollMode } * @syscap SystemCapability.Web.Webview.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollLeft?: NestedScrollMode; } @@ -9607,7 +10210,8 @@ declare interface NestedScrollOptionsExt { * * @typedef EmbedOptions * @syscap SystemCapability.Web.Webview.Core - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface EmbedOptions { /** @@ -9617,7 +10221,8 @@ declare interface EmbedOptions { * @type { ?boolean } * @default false * @syscap SystemCapability.Web.Webview.Core - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ supportDefaultIntrinsicSize?: boolean; } diff --git a/api/@internal/component/ets/window_scene.d.ts b/api/@internal/component/ets/window_scene.d.ts index 2505dfdb6eebf245e1056fa29e679556ca8b6ae6..032103b5187f7a1f71d7e0030ae7e7eaefeb4961 100644 --- a/api/@internal/component/ets/window_scene.d.ts +++ b/api/@internal/component/ets/window_scene.d.ts @@ -18,13 +18,19 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Position } from './units' +import { CommonMethod } from './common' +/*** endif */ + /** * Defines the interface of WindowScene. * * @interface WindowSceneInterface * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface WindowSceneInterface { /** @@ -34,7 +40,8 @@ interface WindowSceneInterface { * @returns { WindowSceneAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ (persistentId: number): WindowSceneAttribute; } @@ -45,7 +52,8 @@ interface WindowSceneInterface { * @extends CommonMethod * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare class WindowSceneAttribute extends CommonMethod { /** @@ -58,7 +66,8 @@ declare class WindowSceneAttribute extends CommonMethod { * @returns { WindowSceneAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ attractionEffect(destination: Position, fraction: number): WindowSceneAttribute; } diff --git a/api/@internal/component/ets/with_theme.d.ts b/api/@internal/component/ets/with_theme.d.ts index 2de31a46ac690350406b37cf98c9e0a22e9e0ce6..7d1f2ce37928f907c6b9e6de7ca722a14637655f 100644 --- a/api/@internal/component/ets/with_theme.d.ts +++ b/api/@internal/component/ets/with_theme.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CustomTheme } from '../../@ohos.arkui.theme'; +import { ThemeColorMode } from './common'; +/*** endif */ /** * CustomTheme. @@ -37,7 +41,8 @@ declare type CustomTheme = import('../api/@ohos.arkui.theme').CustomTheme; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface WithThemeOptions { /** @@ -47,7 +52,8 @@ declare interface WithThemeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ theme?: CustomTheme; @@ -58,7 +64,8 @@ declare interface WithThemeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ colorMode?: ThemeColorMode; } @@ -82,7 +89,8 @@ declare type WithThemeInterface = (options: WithThemeOptions) => WithThemeAttrib * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice -* @since 12 +* @since arkts {'1.1':'12','1.2':'20'} +* @arkts 1.1&1.2 */ declare class WithThemeAttribute { } diff --git a/api/@internal/component/ets/xcomponent.d.ts b/api/@internal/component/ets/xcomponent.d.ts index e18066bc58623a4d3f7d0265d32eb4c6a38ed5b0..06f38f200901f22348d65d11443718efc5431d2b 100644 --- a/api/@internal/component/ets/xcomponent.d.ts +++ b/api/@internal/component/ets/xcomponent.d.ts @@ -18,13 +18,21 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { ImageAIOptions, ImageAnalyzerConfig } from './imageCommon'; +import { CommonMethod } from './common'; +import { XComponentType } from './enums'; +import { VoidCallback } from './units'; +/*** endif */ + /** * Surface Rectangle information. * * @interface SurfaceRect * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SurfaceRect { /** @@ -33,7 +41,8 @@ declare interface SurfaceRect { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offsetX?: number; @@ -43,7 +52,8 @@ declare interface SurfaceRect { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offsetY?: number; @@ -53,7 +63,8 @@ declare interface SurfaceRect { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ surfaceWidth: number; @@ -63,7 +74,8 @@ declare interface SurfaceRect { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ surfaceHeight: number; } @@ -74,7 +86,8 @@ declare interface SurfaceRect { * @interface SurfaceRotationOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface SurfaceRotationOptions { /** @@ -83,7 +96,8 @@ declare interface SurfaceRotationOptions { * @type { ?boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lock?: boolean; } @@ -100,7 +114,8 @@ declare interface SurfaceRotationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class XComponentController { /** @@ -115,7 +130,8 @@ declare class XComponentController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -133,7 +149,8 @@ declare class XComponentController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getXComponentSurfaceId(): string; @@ -151,7 +168,8 @@ declare class XComponentController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getXComponentContext(): Object; @@ -175,7 +193,8 @@ declare class XComponentController { * @param { SurfaceRect } rect - The surface rectangle information. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setXComponentSurfaceRect(rect: SurfaceRect): void; @@ -185,7 +204,8 @@ declare class XComponentController { * @returns { SurfaceRect } The surface rectangle information. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getXComponentSurfaceRect(): SurfaceRect; @@ -195,7 +215,8 @@ declare class XComponentController { * @param { SurfaceRotationOptions } rotationOptions - The surface rotation options. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setXComponentSurfaceRotation(rotationOptions: SurfaceRotationOptions): void; @@ -205,7 +226,8 @@ declare class XComponentController { * @returns { Required } The surface rotation options result. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getXComponentSurfaceRotation(): Required; @@ -215,7 +237,8 @@ declare class XComponentController { * @param { string } surfaceId - The id of the surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSurfaceCreated(surfaceId: string): void; @@ -226,7 +249,8 @@ declare class XComponentController { * @param { SurfaceRect } rect - The rectangle information of the surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSurfaceChanged(surfaceId: string, rect: SurfaceRect): void; @@ -236,7 +260,8 @@ declare class XComponentController { * @param { string } surfaceId - The id of the surface created by XComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onSurfaceDestroyed(surfaceId: string): void; @@ -250,7 +275,8 @@ declare class XComponentController { * @throws { BusinessError } 110003 - Image analysis is stopped. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ startImageAnalyzer(config: ImageAnalyzerConfig): Promise; @@ -259,7 +285,8 @@ declare class XComponentController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stopImageAnalyzer(): void; } @@ -270,7 +297,8 @@ declare class XComponentController { * @interface XComponentOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface XComponentOptions { /** @@ -279,7 +307,8 @@ declare interface XComponentOptions { * @type { XComponentType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: XComponentType; @@ -289,7 +318,8 @@ declare interface XComponentOptions { * @type { XComponentController } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ controller: XComponentController; @@ -299,7 +329,8 @@ declare interface XComponentOptions { * @type { ?ImageAIOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ imageAIOptions?: ImageAIOptions; @@ -309,7 +340,8 @@ declare interface XComponentOptions { * @type { ?number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 17 + * @since arkts {'1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ screenId?: number; } @@ -320,7 +352,8 @@ declare interface XComponentOptions { * @interface NativeXComponentParameters * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface NativeXComponentParameters { /** @@ -329,7 +362,8 @@ declare interface NativeXComponentParameters { * @type { XComponentType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ type: XComponentType; @@ -339,7 +373,8 @@ declare interface NativeXComponentParameters { * @type { ?ImageAIOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ imageAIOptions?: ImageAIOptions; } @@ -424,7 +459,8 @@ interface XComponentInterface { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare type OnNativeLoadCallback = (event?: object) => void; @@ -442,7 +478,8 @@ declare type OnNativeLoadCallback = (event?: object) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class XComponentAttribute extends CommonMethod { /** @@ -471,7 +508,8 @@ declare class XComponentAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onLoad(callback: OnNativeLoadCallback): XComponentAttribute; @@ -501,7 +539,8 @@ declare class XComponentAttribute extends CommonMethod { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ onDestroy(event: VoidCallback): XComponentAttribute; @@ -512,7 +551,8 @@ declare class XComponentAttribute extends CommonMethod { * @returns { XComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableAnalyzer(enable: boolean): XComponentAttribute; @@ -523,7 +563,8 @@ declare class XComponentAttribute extends CommonMethod { * @returns { XComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enableSecure(isSecure: boolean): XComponentAttribute; @@ -536,6 +577,16 @@ declare class XComponentAttribute extends CommonMethod { * @systemapi * @since 14 */ + /** + * Set hdrBrightness for XComponent. + * + * @param { number } brightness - control the brightness of HDR video + * @returns { XComponentAttribute } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts {'1.1':20,'1.2':20} + * @arkts 1.1&1.2 + */ hdrBrightness(brightness: number): XComponentAttribute; /** @@ -545,7 +596,8 @@ declare class XComponentAttribute extends CommonMethod { * @returns { XComponentAttribute } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enableTransparentLayer(enabled: boolean): XComponentAttribute; } @@ -581,3 +633,109 @@ declare const XComponent: XComponentInterface; * @since 12 */ declare const XComponentInstance: XComponentAttribute; + +/** + * Defines the XComponent parameter interface. + * + * @interface XComponentParameter + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +declare interface XComponentParameter { + /** + * The id of xcomponent + * + * @type { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + id: string; + /** + * The type of xcomponent + * + * @type { XComponentType } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type: XComponentType; + /** + * The name of the dynamic library compiled and output by the native layer. + * + * @type { ?string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + libraryname?: string; + /** + * The controller of xcomponent. + * + * @type { ?XComponentController } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + controller?: XComponentController; +} + +/** + * Defines XComponent. + * + * @interface XComponentInterface + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +interface XComponentInterface { + /** + * Constructor parameters + * + * @param { XComponentParameter } value - Indicates the options of the xcomponent. + * @returns { XComponentAttribute } The attribute of the xcomponent. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (value: XComponentParameter): XComponentAttribute; + + /** + * Constructor parameters + * + * @param { XComponentOptions } options - Indicates the options of the xcomponent. + * @returns { XComponentAttribute } The attribute of the xcomponent. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (options: XComponentOptions): XComponentAttribute; + + /** + * Constructor parameters + * + * @param { NativeXComponentParameters } params - Indicates the constructor parameters of the xcomponent for native developing. + * @returns { XComponentAttribute } The attribute of the xcomponent. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + (params: NativeXComponentParameters): XComponentAttribute; +} \ No newline at end of file diff --git a/api/@internal/ets/global.d.ets b/api/@internal/ets/global.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..06cedd8482f75cfc45f081bfe5932716878521ae --- /dev/null +++ b/api/@internal/ets/global.d.ets @@ -0,0 +1,382 @@ +/* + * Copyright (c) 2021-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. + */ + +/** + * @file + * @kit ArkUI + */ + +import { TouchObject, KeyEvent, MouseEvent } from '../../../api/arkui/component/common'; + +/** + * Sets the interval for repeatedly calling a function. + * + * @param { Function | string } handler - Indicates the function to be called after the timer goes off. + * For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. + * For devices of "lite wearable" and "smartVision" types, this parameter must be a function. + * @param { number } delay - Indicates the interval between each two calls, in milliseconds. The function will be called after this delay. + * @param { any[] } arguments - Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns { number } Returns the timer ID. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 7 + */ +/** + * Sets the interval for repeatedly calling a function. + * + * @param { Function | string } handler - Indicates the function to be called after the timer goes off. + * For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. + * For devices of "lite wearable" and "smartVision" types, this parameter must be a function. + * @param { number } delay - Indicates the interval between each two calls, in milliseconds. The function will be called after this delay. + * @param { any[] } arguments - Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns { number } Returns the timer ID. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Sets the interval for repeatedly calling a function. + * + * @param { Function | string } handler - Indicates the function to be called after the timer goes off. + * For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. + * For devices of "lite wearable" and "smartVision" types, this parameter must be a function. + * @param { number } delay - Indicates the interval between each two calls, in milliseconds. The function will be called after this delay. + * @param { any[] } arguments - Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns { number } Returns the timer ID. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +export declare function setInterval(func: () => void, delay: int): int; + +/** + * Sets a timer after which a function will be executed. + * + * @param { Function | string } handler - Indicates the function to be called after the timer goes off. + * For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. + * For devices of "lite wearable" and "smartVision" types, this parameter must be a function. + * @param { number } [delay] - Indicates the delay (in milliseconds) after which the function will be called. + * If this parameter is left empty, default value "0" will be used, which means that the function will be called immediately or as soon as possible. + * @param { any[] } arguments - Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns { number } Returns the timer ID. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 7 + */ +/** + * Sets a timer after which a function will be executed. + * + * @param { Function | string } handler - Indicates the function to be called after the timer goes off. + * For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. + * For devices of "lite wearable" and "smartVision" types, this parameter must be a function. + * @param { number } [delay] - Indicates the delay (in milliseconds) after which the function will be called. + * If this parameter is left empty, default value "0" will be used, which means that the function will be called immediately or as soon as possible. + * @param { any[] } [arguments] - Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns { number } Returns the timer ID. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Sets a timer after which a function will be executed. + * + * @param { Function | string } handler - Indicates the function to be called after the timer goes off. + * For devices of "tv", "phone, tablet", and "wearable" types, this parameter can be a function or string. + * For devices of "lite wearable" and "smartVision" types, this parameter must be a function. + * @param { number } [delay] - Indicates the delay (in milliseconds) after which the function will be called. + * If this parameter is left empty, default value "0" will be used, which means that the function will be called immediately or as soon as possible. + * @param { any[] } [arguments] - Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns { number } Returns the timer ID. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +export declare function setTimeout(func: () => void, delay?: int): int; + +/** + * Cancel the interval set by " setInterval()". + * + * @param { number } [intervalID] - Indicates the timer ID returned by "setInterval()". + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 7 + */ +/** + * Cancel the interval set by " setInterval()". + * + * @param { number } [intervalID] - Indicates the timer ID returned by "setInterval()". + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Cancel the interval set by " setInterval()". + * + * @param { number } [intervalID] - Indicates the timer ID returned by "setInterval()". + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +export declare function clearInterval(intervalID: int): void; + +/** + * Cancel the timer set by "setTimeout()". + * + * @param { number } [timeoutID] - Indicates the timer ID returned by "setTimeout()". + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 7 + */ +/** + * Cancel the timer set by "setTimeout()". + * + * @param { number } [timeoutID] - Indicates the timer ID returned by "setTimeout()". + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Cancel the timer set by "setTimeout()". + * + * @param { number } [timeoutID] - Indicates the timer ID returned by "setTimeout()". + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +export declare function clearTimeout(timeoutID: int): void; + +/** + * Defining syscap function. + * + * @param { string } syscap + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 8 + */ +/** + * Defining syscap function. + * + * @param { string } syscap + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + */ +/** + * Defining syscap function. + * + * @param { string } syscap + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + */ +export declare function canIUse(syscap: string): boolean; + +/** + * Obtains all attributes of the component with the specified ID. + * + * @param { string } id - ID of the component whose attributes are to be obtained. + * @returns { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 9 + * @test + */ +/** + * Obtains all attributes of the component with the specified ID. + * + * @param { string } id - ID of the component whose attributes are to be obtained. + * @returns { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + * @test + */ +/** + * Obtains all attributes of the component with the specified ID. + * + * @param { string } id - ID of the component whose attributes are to be obtained. + * @returns { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ +export declare function getInspectorByKey(id: string): string; + +/** + * Get components tree. + * + * @returns { Object } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 9 + * @test + */ +/** + * Get components tree. + * + * @returns { Object } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + * @test + */ +/** + * Get components tree. + * + * @returns { Object } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ +export declare function getInspectorTree(): Object; + +/** + * Sends an event to the component with the specified ID. + * + * @param { string } id - ID of the component for which the event is to be sent. + * @param { number } action - Type of the event to be sent. The options are as follows: Click event: 10 LongClick: 11. + * @param { string } params - Event parameters. If there is no parameter, pass an empty string "". + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 9 + * @test + */ +/** + * Sends an event to the component with the specified ID. + * + * @param { string } id - ID of the component for which the event is to be sent. + * @param { number } action - Type of the event to be sent. The options are as follows: Click event: 10 LongClick: 11. + * @param { string } params - Event parameters. If there is no parameter, pass an empty string "". + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + * @test + */ +/** + * Sends an event to the component with the specified ID. + * + * @param { string } id - ID of the component for which the event is to be sent. + * @param { number } action - Type of the event to be sent. The options are as follows: Click event: 10 LongClick: 11. + * @param { string } params - Event parameters. If there is no parameter, pass an empty string "". + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ +export declare function sendEventByKey(id: string, action: number, params: string): boolean; + +/** + * Send touch event. + * + * @param { TouchObject } event - TouchObject to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 9 + * @test + */ +/** + * Send touch event. + * + * @param { TouchObject } event - TouchObject to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + * @test + */ +/** + * Send touch event. + * + * @param { TouchObject } event - TouchObject to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ +export declare function sendTouchEvent(event: TouchObject): boolean; + +/** + * Send key event. + * + * @param { KeyEvent } event - KeyEvent to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 9 + * @test + */ +/** + * Send key event. + * + * @param { KeyEvent } event - KeyEvent to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + * @test + */ +/** + * Send key event. + * + * @param { KeyEvent } event - KeyEvent to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ +export declare function sendKeyEvent(event: KeyEvent): boolean; + +/** + * Send mouse event. + * + * @param { MouseEvent } event - MouseEvent to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 9 + * @test + */ +/** + * Send mouse event. + * + * @param { MouseEvent } event - MouseEvent to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @since 10 + * @test + */ +/** + * Send mouse event. + * + * @param { MouseEvent } event - MouseEvent to be sent. + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ +export declare function sendMouseEvent(event: MouseEvent): boolean; diff --git a/api/@ohos.InputMethodSubtype.d.ts b/api/@ohos.InputMethodSubtype.d.ts index c86eeccd74ef19225e46894ee3987fa19f6eccd7..0291b403d29315d0dcb832eff3166b9d229dd877 100644 --- a/api/@ohos.InputMethodSubtype.d.ts +++ b/api/@ohos.InputMethodSubtype.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022 Huawei Device Co., Ltd. + * Copyright (c) 2022-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 @@ -23,7 +23,8 @@ * * @interface InputMethodSubtype * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export default interface InputMethodSubtype { /** @@ -32,7 +33,8 @@ export default interface InputMethodSubtype { * @type { ?string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly label?: string; @@ -42,7 +44,8 @@ export default interface InputMethodSubtype { * @type { ?number } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly labelId?: number; @@ -52,7 +55,8 @@ export default interface InputMethodSubtype { * @type { string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly name: string; @@ -62,7 +66,8 @@ export default interface InputMethodSubtype { * @type { string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly id: string; @@ -72,7 +77,8 @@ export default interface InputMethodSubtype { * @type { ?('upper' | 'lower') } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly mode?: 'upper' | 'lower'; @@ -82,7 +88,8 @@ export default interface InputMethodSubtype { * @type { string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly locale: string; @@ -92,7 +99,8 @@ export default interface InputMethodSubtype { * @type { string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly language: string; @@ -102,7 +110,8 @@ export default interface InputMethodSubtype { * @type { ?string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly icon?: string; @@ -112,7 +121,8 @@ export default interface InputMethodSubtype { * @type { ?number } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly iconId?: number; @@ -128,7 +138,8 @@ export default interface InputMethodSubtype { * * @type { ?object } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ extra?: object; } \ No newline at end of file diff --git a/api/@ohos.PiPWindow.d.ts b/api/@ohos.PiPWindow.d.ts index 81ebbcadcb6e558ee34462d59dfd6a787a8dbac4..f8a9524aba23972042b95d816e8ecfbe66a8a475 100644 --- a/api/@ohos.PiPWindow.d.ts +++ b/api/@ohos.PiPWindow.d.ts @@ -21,7 +21,12 @@ import type BaseContext from './application/BaseContext'; import type { Callback } from './@ohos.base'; import { NodeController } from './arkui/NodeController'; +/*** if arkts 1.1 */ import { typeNode } from './arkui/FrameNode'; +/*** endif */ +/*** if arkts 1.2 */ +import { XComponentController } from './arkui/component/xcomponent'; +/*** endif */ /** * Picture In Picture Window Manager @@ -36,7 +41,8 @@ import { typeNode } from './arkui/FrameNode'; * @namespace PiPWindow * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace PiPWindow { /** @@ -52,7 +58,8 @@ declare namespace PiPWindow { * @returns { boolean } true if PictureInPicture enabled, otherwise false * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function isPiPEnabled(): boolean; @@ -119,7 +126,8 @@ declare namespace PiPWindow { * @interface PiPConfiguration * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PiPConfiguration { /** @@ -135,7 +143,8 @@ declare namespace PiPWindow { * @type { BaseContext } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ context: BaseContext; @@ -152,7 +161,8 @@ declare namespace PiPWindow { * @type { XComponentController } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ componentController: XComponentController; @@ -169,7 +179,8 @@ declare namespace PiPWindow { * @type { ?string } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ navigationId?: string; @@ -186,7 +197,8 @@ declare namespace PiPWindow { * @type { ?PiPTemplateType } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ templateType?: PiPTemplateType; @@ -203,7 +215,8 @@ declare namespace PiPWindow { * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ contentWidth?: number; @@ -220,7 +233,8 @@ declare namespace PiPWindow { * @type { ?number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ contentHeight?: number; @@ -230,7 +244,8 @@ declare namespace PiPWindow { * @type { ?Array } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ controlGroups?: Array; @@ -240,7 +255,8 @@ declare namespace PiPWindow { * @type { ?NodeController } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ customUIController?: NodeController; } @@ -251,16 +267,18 @@ declare namespace PiPWindow { * @interface PiPWindowSize * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface PiPWindowSize { + interface PiPWindowSize { /** * The width of the picture-in-picture window. * * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -270,7 +288,8 @@ declare namespace PiPWindow { * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -280,7 +299,8 @@ declare namespace PiPWindow { * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ scale: number; } @@ -291,7 +311,8 @@ declare namespace PiPWindow { * @interface PiPWindowInfo * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PiPWindowInfo { /** @@ -300,7 +321,8 @@ declare namespace PiPWindow { * @type { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ windowId: number; @@ -310,7 +332,8 @@ declare namespace PiPWindow { * @type { PiPWindowSize } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ size: PiPWindowSize; } @@ -328,7 +351,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PiPTemplateType { /** @@ -340,7 +364,8 @@ declare namespace PiPWindow { * Indicates the content to show in picture-in-picture window is video play * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_PLAY, @@ -353,7 +378,8 @@ declare namespace PiPWindow { * Indicates the content to show in picture-in-picture window is video call * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_CALL, @@ -366,7 +392,8 @@ declare namespace PiPWindow { * Indicates the content to show in picture-in-picture window is video meeting * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_MEETING, @@ -379,7 +406,8 @@ declare namespace PiPWindow { * Indicates the content to show in picture-in-picture window is video live * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_LIVE, } @@ -397,7 +425,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PiPState { /** @@ -411,7 +440,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ABOUT_TO_START = 1, @@ -426,7 +456,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ STARTED = 2, @@ -441,7 +472,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ABOUT_TO_STOP = 3, @@ -456,7 +488,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ STOPPED = 4, @@ -471,7 +504,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ABOUT_TO_RESTORE = 5, @@ -486,7 +520,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ERROR = 6, } @@ -497,7 +532,8 @@ declare namespace PiPWindow { * @typedef { VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup | VideoLiveControlGroup } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type PiPControlGroup = VideoPlayControlGroup | VideoCallControlGroup | VideoMeetingControlGroup | VideoLiveControlGroup; @@ -507,7 +543,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoPlayControlGroup { /** @@ -515,7 +552,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_PREVIOUS_NEXT = 101, @@ -524,7 +562,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FAST_FORWARD_BACKWARD = 102, } @@ -535,7 +574,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoCallControlGroup { /** @@ -543,7 +583,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MICROPHONE_SWITCH = 201, @@ -552,7 +593,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ HANG_UP_BUTTON = 202, @@ -561,7 +603,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_SWITCH = 203, @@ -570,7 +613,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MUTE_SWITCH = 204, } @@ -581,7 +625,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoMeetingControlGroup { /** @@ -589,7 +634,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ HANG_UP_BUTTON = 301, @@ -598,7 +644,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_SWITCH = 302, @@ -607,7 +654,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MUTE_SWITCH = 303, @@ -616,7 +664,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MICROPHONE_SWITCH = 304, } @@ -627,7 +676,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoLiveControlGroup { /** @@ -635,7 +685,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_PLAY_PAUSE = 401, @@ -644,7 +695,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MUTE_SWITCH = 402, } @@ -655,7 +707,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PiPControlStatus { /** @@ -663,7 +716,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PLAY = 1, @@ -672,7 +726,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PAUSE = 0, @@ -681,7 +736,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPEN = 1, @@ -690,7 +746,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CLOSE = 0, } @@ -701,7 +758,8 @@ declare namespace PiPWindow { * @enum { number }. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PiPControlType { /** @@ -709,7 +767,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_PLAY_PAUSE = 0, @@ -718,7 +777,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_PREVIOUS = 1, @@ -727,7 +787,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_NEXT = 2, @@ -736,7 +797,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FAST_FORWARD = 3, @@ -745,7 +807,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FAST_BACKWARD = 4, @@ -754,7 +817,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ HANG_UP_BUTTON = 5, @@ -763,7 +827,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MICROPHONE_SWITCH = 6, @@ -772,7 +837,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_SWITCH = 7, @@ -781,7 +847,8 @@ declare namespace PiPWindow { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MUTE_SWITCH = 8, } @@ -800,7 +867,8 @@ declare namespace PiPWindow { * @typedef { PiPVideoActionEvent | PiPCallActionEvent | PiPMeetingActionEvent | PiPLiveActionEvent } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type PiPActionEventType = PiPVideoActionEvent | PiPCallActionEvent | PiPMeetingActionEvent | PiPLiveActionEvent; @@ -817,7 +885,8 @@ declare namespace PiPWindow { * @typedef { 'playbackStateChanged' | 'nextVideo' | 'previousVideo' | 'fastForward' | 'fastBackward' } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type PiPVideoActionEvent = 'playbackStateChanged' | 'nextVideo' | 'previousVideo' | 'fastForward' | 'fastBackward'; @@ -834,7 +903,8 @@ declare namespace PiPWindow { * @typedef { 'hangUp' | 'micStateChanged' | 'videoStateChanged' | 'voiceStateChanged' } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type PiPCallActionEvent = 'hangUp' | 'micStateChanged' | 'videoStateChanged' | 'voiceStateChanged'; @@ -851,7 +921,8 @@ declare namespace PiPWindow { * @typedef { 'hangUp' | 'voiceStateChanged' | 'videoStateChanged' | 'micStateChanged' } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type PiPMeetingActionEvent = 'hangUp' | 'voiceStateChanged' | 'videoStateChanged' | 'micStateChanged'; @@ -868,7 +939,8 @@ declare namespace PiPWindow { * @typedef { 'playbackStateChanged' | 'voiceStateChanged' } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type PiPLiveActionEvent = 'playbackStateChanged' | 'voiceStateChanged'; @@ -880,7 +952,8 @@ declare namespace PiPWindow { * @param { number } [status] - the status of control button * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type ControlPanelActionEventCallback = (event: PiPActionEventType, status?: number) => void; @@ -890,7 +963,8 @@ declare namespace PiPWindow { * @interface ControlEventParam * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ControlEventParam { /** @@ -899,7 +973,8 @@ declare namespace PiPWindow { * @type { PiPControlType } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ controlType: PiPControlType; @@ -909,7 +984,8 @@ declare namespace PiPWindow { * @type { ?PiPControlStatus } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ status?: PiPControlStatus; } @@ -927,7 +1003,8 @@ declare namespace PiPWindow { * @interface PiPController * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PiPController { @@ -950,7 +1027,8 @@ declare namespace PiPWindow { * @throws { BusinessError } 1300015 - Repeated PiP operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ startPiP(): Promise; @@ -971,7 +1049,8 @@ declare namespace PiPWindow { * @throws { BusinessError } 1300015 - Repeated PiP operation. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ stopPiP(): Promise; @@ -1036,9 +1115,10 @@ declare namespace PiPWindow { * @syscap SystemCapability.Window.SessionManager * @atomicservice * @since 18 + * @arkts 1.1 */ updateContentNode(contentNode: typeNode.XComponent): Promise; - + /** * Set Dashboard control enable status. * @param { PiPControlType } controlType - Describe picture-in-picture control type. diff --git a/api/@ohos.UiTest.d.ts b/api/@ohos.UiTest.d.ts old mode 100644 new mode 100755 index c1c63e9a803f820d265fe13db8482926ac9619d2..b45551debf6d7b8176983f42f96b9896e24afc1e --- a/api/@ohos.UiTest.d.ts +++ b/api/@ohos.UiTest.d.ts @@ -18,4835 +18,5165 @@ * @kit TestKit */ -import { Callback } from './@ohos.base'; - -/** - * Enumerates the string value match pattern. - * - * @enum {number} - * @syscap SystemCapability.Test.UiTest - * @since 8 - */ -/** - * Enumerates the string value match pattern. - * - * @enum {number} - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - */ -/** - * Enumerates the string value match pattern. - * - * @enum {number} - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - */ -declare enum MatchPattern { - /** - * Equals to a string. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @test - */ - /** - * Equals to a string. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Equals to a string. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - EQUALS = 0, - /** - * Contains a substring. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @test - */ - /** - * Contains a substring. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Contains a substring. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - CONTAINS = 1, - /** - * StartsWith a substring. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @test - */ - /** - * StartsWith a substring. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * StartsWith a substring. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - STARTS_WITH = 2, - /** - * EndsWith a substring. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @test - */ - /** - * EndsWith a substring. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * EndsWith a substring. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - ENDS_WITH = 3, - /** - * Matches the given value using a regular expression, which is case sensitive. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - */ - REG_EXP = 4, - /** - * Matches the given value using a regular expression, which is case insensitive. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - */ - REG_EXP_ICASE = 5, -} - -/** - * Describes the attribute requirements for the target UiComponents. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On - */ -declare class By { - /** - * Specifies the text for the target UiComponent. - * - * @param { string } txt The text value. - * @param { MatchPattern } pattern The {@link MatchPattern} of the text value,default to {@link MatchPattern.EQUALS} - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#text - * @test - */ - text(txt: string, pattern?: MatchPattern): By; - - /** - * Specifies the inspector key of the target UiComponent. - * - * @param { string } key The inspectorKey value. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#id - * @test - */ - key(key: string): By; - - /** - * Specifies the id of the target UiComponent. - * - * @param { number } id The id value. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @test - */ - id(id: number): By; - - /** - * Specifies the type of the target UiComponent. - * - * @param { string } tp The type value. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#type - * @test - */ - type(tp: string): By; - - /** - * Specifies the clickable status of the target UiComponent. - * - * @param { boolean } b The clickable status,default to true. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#clickable - * @test - */ - clickable(b?: boolean): By; - - /** - * Specifies the scrollable status of the target UiComponent. - * - * @param { boolean } b The scrollable status,default to true. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#scrollable - * @test - */ - scrollable(b?: boolean): By; - - /** - * Specifies the enabled status of the target UiComponent. - * - * @param { boolean } b The enabled status,default to true. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#enabled - * @test - */ - enabled(b?: boolean): By; - - /** - * Specifies the focused status of the target UiComponent. - * - * @param { boolean } b The focused status,default to true. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#focused - * @test - */ - focused(b?: boolean): By; - - /** - * Specifies the selected status of the target UiComponent. - * - * @param { boolean } b The selected status,default to true. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#selected - * @test - */ - selected(b?: boolean): By; - - /** - * Requires the target UiComponent which is before another UiComponent that specified by the given {@link By} - * object,used to locate UiComponent relatively. - * - * @param { By } by Describes the attribute requirements of UiComponent which the target one is in front of. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#isBefore - * @test - */ - isBefore(by: By): By; - - /** - * Requires the target UiComponent which is after another UiComponent that specified by the given {@link By} - * object,used to locate UiComponent relatively. - * - * @param { By } by Describes the attribute requirements of UiComponent which the target one is in back of. - * @returns { By } this {@link By} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.On#isAfter - * @test - */ - isAfter(by: By): By; -} - -/** - * Represents a UiComponent of the ohos application,user can perform operations or query attributes on it. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.uitest.Component - * @test - */ -declare class UiComponent { - /** - * Click this {@link UiComponent}. - * - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#click - * @test - */ - click(): Promise; - - /** - * Double click this {@link UiComponent}. - * - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#doubleClick - * @test - */ - doubleClick(): Promise; - - /** - * Long click this {@link UiComponent}. - * - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#longClick - * @test - */ - longClick(): Promise; - - /** - * Get the id attribute value. - * - * @returns { Promise } the id value. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @test - */ - getId(): Promise; - - /** - * Get the inspectorKey attribute value. - * - * @returns { Promise } the inspectorKey value. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#getId - * @test - */ - getKey(): Promise; - - /** - * Get the text attribute value. - * - * @returns { Promise } the text value. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#getText - * @test - */ - getText(): Promise; - - /** - * Get the type name. - * - * @returns { Promise } the type name. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#getType - * @test - */ - getType(): Promise; - - /** - * Get the clickable status of this {@link UiComponent}. - * - * @returns { Promise } the clickable status. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#isClickable - * @test - */ - isClickable(): Promise; - - /** - * Get the scrollable status of this {@link UiComponent}. - * - * @returns { Promise } the scrollable status. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#isScrollable - * @test - */ - isScrollable(): Promise; - - /** - * Get the enabled status of this {@link UiComponent}. - * - * @returns { Promise } the enabled status. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#isEnabled - * @test - */ - isEnabled(): Promise; - - /** - * Get the focused status of this {@link UiComponent}. - * - * @returns { Promise } the focused status. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#isFocused - * @test - */ - isFocused(): Promise; - - /** - * Get the selected status of this {@link UiComponent}. - * - * @returns { Promise } the selected status. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#isSelected - * @test - */ - isSelected(): Promise; - - /** - * Inject text to this {@link UiComponent},applicable to TextInput. - * - * @param { string } text The text to inject. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#inputText - * @test - */ - inputText(text: string): Promise; - - /** - * Scroll on this {@link UiComponent}to find matched {@link UiComponent},applicable to scrollable one. - * - * @param { By } by The attribute requirements of the target {@link UiComponent}. - * @returns { Promise } the found result,or undefined if not found. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Component#scrollSearch - * @test - */ - scrollSearch(by: By): Promise; -} - -/** - * The unified facade of UiTest framework,can be used to find {@link UiComponent},trigger keyEvents,perform - * coordinates-based UI actions,capture screen and so on. - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.uitest.Driver - * @test - */ -declare class UiDriver { - /** - * Create an {@link UiDriver} object. - * - * @returns { UiDriver } the {@link UiDriver} object. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#create - * @test - */ - static create(): UiDriver; - - /** - * Delay with specified duration. - * - * @param { number } duration The delay duration in milliseconds. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#delayMs - * @test - */ - delayMs(duration: number): Promise; - - /** - * Find the first matched {@link UiComponent} on current UI. - * - * @param { By } by The attribute requirements of the target {@link UiComponent}. - * @returns { Promise } the first matched {@link UiComponent} or undefined. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#findComponent - * @test - */ - findComponent(by: By): Promise; - - /** - * Find all the matched {@link UiComponent}s on current UI. - * - * @param { By } by The attribute requirements of the target {@link UiComponent}. - * @returns { Promise> } the matched {@link UiComponent}s list. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#findComponents - * @test - */ - findComponents(by: By): Promise>; - - /** - * Assert the matched {@link UiComponent}s exists on current UI;if not,assertError will be raised. - * - * @param { By } by The attribute requirements of the target {@link UiComponent}. - * @returns { Promise } - * @throws {BusinessError} 401 - if the input parameters are invalid. - * @throws {BusinessError} 17000002 - if the async function was not called with await. - * @throws {BusinessError} 17000003 - if the assertion failed. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#assertComponentExist - * @test - */ - assertComponentExist(by: By): Promise; - - /** - * Press the BACK key. - * - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#pressBack - * @test - */ - pressBack(): Promise; - - /** - * Press the specified key. - * - * @param { number } keyCode the target keyCode. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#triggerKey - * @test - */ - triggerKey(keyCode: number): Promise; - - /** - * Click on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#click - * @test - */ - click(x: number, y: number): Promise; - - /** - * DoubleClick on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#doubleClick - * @test - */ - doubleClick(x: number, y: number): Promise; - - /** - * LongClick on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#longClick - * @test - */ - longClick(x: number, y: number): Promise; - - /** - * Swipe on the screen between the specified points. - * - * @param { number } startx The x-coordinate of the starting point. - * @param { number } starty The y-coordinate of the starting point. - * @param { number } endx The x-coordinate of the ending point. - * @param { number } endy The y-coordinate of the ending point. - * @returns { Promise } - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.UiTest.Driver#swipe - * @test - */ - swipe(startx: number, starty: number, endx: number, endy: number): Promise; - - /** - * Capture current screen and save as picture which PNG format. - * - * @param { string } savePath the path where to store the picture. - * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.uitest.Driver#screenCap - * @test - */ - screenCap(savePath: string): Promise; -} - -/** - * Enumerates the window mode of the tested window. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Enumerates the window mode of the tested window. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -declare enum WindowMode { - /** - * The test window is a full screen window. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * The test window is a full screen window. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - FULLSCREEN = 0, - /** - * The test window is the first window in the split screen state. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * The test window is the first window in the split screen state. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - PRIMARY = 1, - /** - * The test window is the second window in the split screen state. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * The test window is the second window in the split screen state. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - SECONDARY = 2, - /** - * The test window is a floating window. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * The test window is a floating window. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - FLOATING = 3, -} - -/** - * Enumerates the resize direction for the window. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Enumerates the resize direction for the window. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -declare enum ResizeDirection { - /** - * Left. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Left. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - LEFT = 0, - /** - * Right. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Right. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - RIGHT = 1, - /** - * Up. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Up. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - UP = 2, - /** - * Down. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Down. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - DOWN = 3, - /** - * Upper left. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Upper left. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - LEFT_UP = 4, - /** - * Lower left. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Lower left. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - LEFT_DOWN = 5, - /** - * Upper right. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Upper right. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - RIGHT_UP = 6, - /** - * Lower right. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Lower right. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - RIGHT_DOWN = 7, -} - -/** - * Enumerates the rotation of the device display. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Enumerates the rotation of the device display. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -declare enum DisplayRotation { - /** - * Device display does not rotate to display vertically. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Device display does not rotate to display vertically. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - ROTATION_0 = 0, - /** - * Device display rotates 90 degrees clockwise to display horizontally. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Device display rotates 90 degrees clockwise to display horizontally. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - ROTATION_90 = 1, - /** - * Device display rotates clockwise 180 degrees to display vertically in reverse. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Device display rotates clockwise 180 degrees to display vertically in reverse. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - ROTATION_180 = 2, - /** - * Device display rotates 270 degrees clockwise to display horizontally in reverse. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Device display rotates 270 degrees clockwise to display horizontally in reverse. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - ROTATION_270 = 3, -} - -/** - * Represents the point on the device screen. - * - * @typedef Point - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Represents the point on the device screen. - * - * @typedef Point - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - */ -/** - * Represents the point on the device screen. - * - * @typedef Point - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - */ -declare interface Point { - /** - * The x-coordinate of the coordinate point. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The x-coordinate of the coordinate point. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - */ - /** - * The x-coordinate of the coordinate point. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - */ - readonly x: number; - /** - * The y-coordinate of the coordinate point. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The y-coordinate of the coordinate point. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - */ - /** - * The y-coordinate of the coordinate point. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - */ - readonly y: number; -} - -/** - * Represents the rectangle area on the device screen. - * - * @typedef Rect - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Represents the rectangle area on the device screen. - * - * @typedef Rect - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -/** - * Represents the rectangle area on the device screen. - * - * @typedef Rect - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ -declare interface Rect { - /** - * The x-coordinate of the top left corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The x-coordinate of the top left corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - /** - * The x-coordinate of the top left corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ - readonly left: number; - /** - * The y-coordinate of the top left corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The y-coordinate of the top left corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - /** - * The y-coordinate of the top left corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ - readonly top: number; - /** - * The x-coordinate at the bottom right corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The x-coordinate at the bottom right corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - /** - * The x-coordinate at the bottom right corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ - readonly right: number; - /** - * The y-coordinate at the bottom right corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The y-coordinate at the bottom right corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - /** - * The y-coordinate at the bottom right corner of the rectangle. - * - * @type { number } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ - readonly bottom: number; -} - -/** - * Represents filer condition to get the window . - * - * @typedef WindowFilter - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Represents filer condition to get the window . - * - * @typedef WindowFilter - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -declare interface WindowFilter { - /** - * The package name of the application which the window belongs to. - * - * @type { ?string } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The package name of the application which the window belongs to. - * - * @type { ?string } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - bundleName?: string; - - /** - * The title of the window. - * - * @type { ?string } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The title of the window. - * - * @type { ?string } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - title?: string; - - /** - * The focal state of the window. - * - * @type { ?boolean } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The focal state of the window. - * - * @type { ?boolean } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - focused?: boolean; - - /** - * The active state of the window. - * - * @type { ?boolean } - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ - /** - * The active state of the window. - * - * @type { ?boolean } - * @syscap SystemCapability.Test.UiTest - * @since 11 - * @deprecated since 11 - * @useinstead ohos.UiTest.WindowFilter#active - */ - actived?: boolean; - - /** - * The active state of the window. - * - * @type { ?boolean } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ - active?: boolean; -} - -/** - * Represents the information of an UI element, can be a component or window. - * - * @typedef UIElementInfo - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ -/** - * Represents the information of an UI element, can be a component or window. - * - * @typedef UIElementInfo - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ -declare interface UIElementInfo { - /** - * The bundle name of the host application. - * @type { string } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * The bundle name of the host application. - * @type { string } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - readonly bundleName: string; - /** - * The component type, set it as 'window' if it's a window. - * @type { string } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * The component type, set it as 'window' if it's a window. - * @type { string } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - readonly type: string; - /** - * The text of component, set it as window's title if it's a window. - * @type { string } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * The text of component, set it as window's title if it's a window. - * @type { string } - * @readonly - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - readonly text: string; -} - -/** - * Observer to monitor UI events. - * - * @typedef UIEventObserver - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ -/** - * Observer to monitor UI events. - * - * @typedef UIEventObserver - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ -declare interface UIEventObserver { - /** - * Listen for toast show once - * - * @param { 'toastShow' } type 'toastShow'. - * @param { Callback } callback function, returns the monitored UIElementInfo. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Listen for toast show once - * - * @param { 'toastShow' } type -'toastShow'. - * @param { Callback } callback - function, returns the monitored UIElementInfo. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - once(type: 'toastShow', callback: Callback): void; - - /** - * Listen for dialog show once - * - * @param { 'dialogShow' } type 'dialogShow'. - * @param { Callback } callback function, returns the monitored UIElementInfo. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Listen for dialog show once - * - * @param { 'dialogShow' } type - 'dialogShow'. - * @param { Callback } callback - function, returns the monitored UIElementInfo. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - once(type: 'dialogShow', callback: Callback): void; -} - -/** - * Enumerates the direction for the UI operation . - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @since 10 - */ -/** - * Enumerates the direction for the UI operation . - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -/** - * Enumerates the direction for the UI operation . - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ -declare enum UiDirection { - /** - * Left. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Left. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - /** - * Left. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ - LEFT = 0, - /** - * Right. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Right. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - /** - * Right. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ - RIGHT = 1, - /** - * Up. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Up. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - /** - * Up. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ - UP = 2, - /** - * Down. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Down. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - /** - * Down. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ - DOWN = 3, -} - -/** - * Enumerates the id of the button on the mouse. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @since 10 - */ -/** - * Enumerates the id of the button on the mouse. - * - * @enum { number } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -declare enum MouseButton { - /** - * Left button of the mouse. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Left button of the mouse. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - MOUSE_BUTTON_LEFT = 0, - /** - * Right button of the mouse.. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Right button of the mouse.. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - MOUSE_BUTTON_RIGHT = 1, - /** - * MIDDLE button of the mouse. - * - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * MIDDLE button of the mouse. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - MOUSE_BUTTON_MIDDLE = 2, -} - -/** - * Additional options touchpad multi-finger swipe gestures. - * @interface TouchPadSwipeOptions - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ -declare interface TouchPadSwipeOptions { - /** - * Whether stay for 1 second and lift up after swipe, default is false. - * @type { ?boolean } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - stay?: boolean; - - /** - * Speed(pixels per second) of touchpad multi-finger swipe, default is 2000, the value ranges from 200 to 40000,set it 2000 if out of range. - * @type { ?number } - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - speed?: number; -} - -/** - * Describes the attribute requirements for the target Components. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - */ -/** - * Describes the attribute requirements for the target Components. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - */ -/** - * Describes the attribute requirements for the target Components. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - */ -declare class On { - /** - * Specifies the text for the target Component. - * - * @param { string } txt The text value. - * @param { MatchPattern } pattern The {@link MatchPattern} of the text value, default to {@link MatchPattern.EQUALS} - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the text for the target Component. - * - * @param { string } txt The text value. - * @param { MatchPattern } pattern The {@link MatchPattern} of the text value, default to {@link MatchPattern.EQUALS} - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the text for the target Component. - * - * @param { string } txt - the text value. - * @param { MatchPattern } [pattern] - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - text(txt: string, pattern?: MatchPattern): On; - - /** - * Specifies the id of the target Component. - * - * @param { string } id The id value. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the id of the target Component. - * - * @param { string } id The id value. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the id of the target Component. - * - * @param { string } id - the id value. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - id(id: string): On; - - /** - * Specifies the type of the target Component. - * - * @param { string } tp The type value. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the type of the target Component. - * - * @param { string } tp The type value. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the type of the target Component. - * - * @param { string } tp - The type value. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - type(tp: string): On; - - /** - * Specifies the clickable status of the target Component. - * - * @param { boolean } b The clickable status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the clickable status of the target Component. - * - * @param { boolean } b The clickable status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the clickable status of the target Component. - * - * @param { boolean } [b] - the clickable status.Set it default true if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - clickable(b?: boolean): On; - - /** - * Specifies the longClickable status of the target Component. - * - * @param { boolean } b The clickable status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the longClickable status of the target Component. - * - * @param { boolean } b The clickable status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the longClickable status of the target Component. - * - * @param { boolean } [b] - the longClickable status.Set it default true if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - longClickable(b?: boolean): On; - - /** - * Specifies the scrollable status of the target Component. - * - * @param { boolean } b The scrollable status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the scrollable status of the target Component. - * - * @param { boolean } b The scrollable status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the scrollable status of the target Component. - * - * @param { boolean } [b] - the scrollable status.Set it default true if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - scrollable(b?: boolean): On; - - /** - * Specifies the enabled status of the target Component. - * - * @param { boolean } b The enabled status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the enabled status of the target Component. - * - * @param { boolean } b The enabled status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the enabled status of the target Component. - * - * @param { boolean } [b] - the enabled status.Set it default true if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - enabled(b?: boolean): On; - - /** - * Specifies the focused status of the target Component. - * - * @param { boolean } b The focused status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the focused status of the target Component. - * - * @param { boolean } b The focused status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the focused status of the target Component. - * - * @param { boolean } [b] - the focused status.Set it default true if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - focused(b?: boolean): On; - - /** - * Specifies the selected status of the target Component. - * - * @param { boolean } b The selected status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the selected status of the target Component. - * - * @param { boolean } b The selected status,default to true. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the selected status of the target Component. - * - * @param { boolean } [b] the - selected status.Set it default true if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - selected(b?: boolean): On; - - /** - * Specifies the checked status of the target Component. - * - * @param { boolean } b The checked status,default to false. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the checked status of the target Component. - * - * @param { boolean } b The checked status,default to false. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the checked status of the target Component. - * - * @param { boolean } [b] - the checked status.Set it default false if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - checked(b?: boolean): On; - - /** - * Specifies the checkable status of the target Component. - * - * @param { boolean } b The checkable status,default to false. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Specifies the checkable status of the target Component. - * - * @param { boolean } b The checkable status,default to false. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Specifies the checkable status of the target Component. - * - * @param { boolean } [b] - the checkable status.Set it default false if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. 1. Incorrect parameter types; 2. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - checkable(b?: boolean): On; - - /** - * Requires that the target Component which is before another Component that specified by the given {@link On} - * object,used to locate Component relatively. - * - * @param { On } on Describes the attribute requirements of Component which the target one is in front of. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Requires that the target Component which is before another Component that specified by the given {@link On} - * object,used to locate Component relatively. - * - * @param { On } on - describes the attribute requirements of Component which the target one is in front of. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isBefore(on: On): On; - - /** - * Requires that the target Component which is after another Component that specified by the given {@link On} - * object,used to locate Component relatively. - * - * @param { On } on Describes the attribute requirements of Component which the target one is in back of. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Requires that the target Component which is after another Component that specified by the given {@link On} - * object,used to locate Component relatively. - * - * @param { On } on - describes the attribute requirements of Component which the target one is in back of. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isAfter(on: On): On; - - /** - * Requires that the target Component which is inside of another Component that specified by the given {@link On} - * object,used to locate Component relatively. - * - * @param { On } on Describes the attribute requirements of Component which the target one is inside of. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Requires that the target Component which is inside of another Component that specified by the given {@link On} - * object,used to locate Component relatively. - * - * @param { On } on - describes the attribute requirements of Component which the target one is inside of. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - within(on: On): On; - - /** - * Specifies the bundleName of the application which the window that the target Component is located belongs. - * - * @param { string } bundleName The bundleName of the specified window. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Specifies the bundleName of the application which the window that the target Component is located belongs. - * - * @param { string } bundleName - the bundleName of the specified window. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - inWindow(bundleName: string): On; - - /** - * Specifies the description for the target Component. - * - * @param { string } val - the description value. - * @param { MatchPattern } [pattern] - the {@link MatchPattern} of description value,set it default {@link MatchPattern.EQUALS} if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - description(val: string, pattern?: MatchPattern): On; - /** - * Specifies the id of the target Component. - * - * @param { string } id - the id value. - * @param { MatchPattern } pattern - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - id(id: string, pattern: MatchPattern): On; - /** - * Specifies the type of the target Component. - * - * @param { string } tp - The type value. - * @param { MatchPattern } pattern - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - type(tp: string, pattern: MatchPattern): On; - /** - * Specifies the hint for the target Component. - * - * @param { string } val - the hint value. - * @param { MatchPattern } [pattern] - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. - * @returns { On } this {@link On} object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - hint(val: string, pattern?: MatchPattern): On; -} - -/** - * Represents an Component of the ohos application,user can perform operations or query attributes on it. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ -/** - * Represents an Component of the ohos application,user can perform operations or query attributes on it. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ -/** - * Represents an Component of the ohos application,user can perform operations or query attributes on it. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ -declare class Component { - /** - * Click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - click(): Promise; - - /** - * Double click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Double click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Double click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - doubleClick(): Promise; - - /** - * Long click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Long click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Long click this {@link Component}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - longClick(): Promise; - - /** - * Get the id attribute value. - * - * @returns { Promise } the id value. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the id attribute value. - * - * @returns { Promise } the id value. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the id attribute value. - * - * @returns { Promise } the id value. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - getId(): Promise; - - /** - * Get the text attribute value. - * - * @returns { Promise } the text value. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the text attribute value. - * - * @returns { Promise } the text value. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the text attribute value. - * - * @returns { Promise } the text value. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - getText(): Promise; - - /** - * Get the type name. - * - * @returns { Promise } the type name. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the type name. - * - * @returns { Promise } the type name. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the type name. - * - * @returns { Promise } the type name. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - getType(): Promise; - - /** - * Get the clickable status of this {@link Component}. - * - * @returns { Promise } the clickable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the clickable status of this {@link Component}. - * - * @returns { Promise } the clickable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the clickable status of this {@link Component}. - * - * @returns { Promise } the clickable status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isClickable(): Promise; - - /** - * Get the longClickable status of this {@link Component}. - * - * @returns { Promise } the longClickable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the longClickable status of this {@link Component}. - * - * @returns { Promise } the longClickable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the clickable status of this {@link Component}. - * - * @returns { Promise } the clickable status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isLongClickable(): Promise; - - /** - * Get the scrollable status of this {@link Component}. - * - * @returns { Promise } the scrollable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the scrollable status of this {@link Component}. - * - * @returns { Promise } the scrollable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the scrollable status of this {@link Component}. - * - * @returns { Promise } the scrollable status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isScrollable(): Promise; - - /** - * Get the enabled status of this {@link Component}. - * - * @returns { Promise } the enabled status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the enabled status of this {@link Component}. - * - * @returns { Promise } the enabled status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the enabled status of this {@link Component}. - * - * @returns { Promise } the enabled status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isEnabled(): Promise; - - /** - * Get the focused status of this {@link Component}. - * - * @returns { Promise } the focused status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the focused status of this {@link Component}. - * - * @returns { Promise } the focused status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the focused status of this {@link Component}. - * - * @returns { Promise } the focused status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isFocused(): Promise; - - /** - * Get the selected status of this {@link Component}. - * - * @returns { Promise } the selected status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the selected status of this {@link Component}. - * - * @returns { Promise } the selected status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the selected status of this {@link Component}. - * - * @returns { Promise } the selected status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isSelected(): Promise; - - /** - * Get the checked status of this {@link Component}. - * - * @returns { Promise } the checked status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the checked status of this {@link Component}. - * - * @returns { Promise } the checked status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the checked status of this {@link Component}. - * - * @returns { Promise } the checked status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isChecked(): Promise; - - /** - * Get the checkable status of this {@link Component}. - * - * @returns { Promise } the checkable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the checkable status of this {@link Component}. - * - * @returns { Promise } the checkable status. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the checkable status of this {@link Component}. - * - * @returns { Promise } the checkable status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - isCheckable(): Promise; - - /** - * Inject text to this {@link Component},applicable to TextInput. - * - * @param { string } text The text to inject. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Inject text to this {@link Component},applicable to TextInput. - * - * @param { string } text The text to inject. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Inject text to this {@link Component},applicable to TextInput. - * - * @param { string } text - the text to inject. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - inputText(text: string): Promise; - - /** - * Clear text of this {@link Component},applicable to TextInput. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Clear text of this {@link Component},applicable to TextInput. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Clear text of this {@link Component},applicable to TextInput. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - clearText(): Promise; - - /** - * Scroll on this {@link Component} to the top,applicable to scrollable one. - * - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Scroll on this {@link Component} to the top,applicable to scrollable one. - * - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Scroll on this {@link Component} to the top,applicable to scrollable one. - * - * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000.Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - scrollToTop(speed?: number): Promise; - - /** - * Scroll on this {@link Component} to the bottom,applicable to scrollable one. - * - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Scroll on this {@link Component} to the bottom,applicable to scrollable one. - * - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Scroll on this {@link Component} to the bottom,applicable to scrollable one. - * - * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - scrollToBottom(speed?: number): Promise; - - /** - * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise } the found result,or undefined if not found. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise } the found result,or undefined if not found. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. - * - * @param { On } on - the attribute requirements of the target {@link Component}. - * @returns { Promise } the found result,or undefined if not found. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - scrollSearch(on: On): Promise; - - /** - * Get the bounds rect of this {@link Component}. - * - * @returns { Promise } the bounds rect object. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the bounds rect of this {@link Component}. - * - * @returns { Promise } the bounds rect object. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - /** - * Get the bounds rect of this {@link Component}. - * - * @returns { Promise } the bounds rect object. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ - getBounds(): Promise; - - /** - * Get the boundsCenter of this {@link Component}. - * - * @returns { Promise } the boundsCenter object. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the boundsCenter of this {@link Component}. - * - * @returns { Promise } the boundsCenter object. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Get the boundsCenter of this {@link Component}. - * - * @returns { Promise } the boundsCenter object. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - getBoundsCenter(): Promise; - - /** - * Drag this {@link Component} to the bounds rect of target Component. - * - * @param { Component } target The target {@link Component}. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Drag this {@link Component} to the bounds rect of target Component. - * - * @param { Component } target - the target {@link Component}. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - dragTo(target: Component): Promise; - - /** - * Pinch enlarge this {@link Component} to the target scale. - * - * @param { number } scale The scale of the pinch enlarge this {@link Component}'s size. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Pinch enlarge this {@link Component} to the target scale. - * - * @param { number } scale - the scale of the pinch enlarge this {@link Component}'s size, ranges greater than 1. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - pinchOut(scale: number): Promise; - - /** - * Pinch shrink this {@link Component} to the target scale. - * - * @param { number } scale The scale of the pinch shrink this {@link Component}'s size. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Pinch shrink this {@link Component} to the target scale. - * - * @param { number } scale - the scale of the pinch shrink this {@link Component}'s size, ranges from 0 to 1. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - pinchIn(scale: number): Promise; - - /** - * Get the description attribute value. - * - * @returns { Promise } the description value. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getDescription(): Promise; - /** - * Get the hint attribute value. - * - * @returns { Promise } the hint value. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - getHint(): Promise; - /** - * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. - * - * @param { On } on - the attribute requirements of the target {@link Component}. - * @param { boolean } [vertical] - Whether the swipe direction is vertical, default is true. - * @param { number } [offset] - Offset from the swipe start/end point to the component border, default is 80. - * @returns { Promise } the found result,or undefined if not found. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - scrollSearch(on: On, vertical?: boolean, offset?: number): Promise; -} - -/** - * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform - * coordinates-based UI actions,capture screen and so on. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ -/** - * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform - * coordinates-based UI actions,capture screen and so on. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ -/** - * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform - * coordinates-based UI actions,capture screen and so on. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ -declare class Driver { - /** - * Create an {@link Driver} object. - * - * @returns { Driver } the {@link Driver} object. - * @throws { BusinessError } 17000001 - if the test framework failed to initialize. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Create an {@link Driver} object. - * - * @returns { Driver } the {@link Driver} object. - * @throws { BusinessError } 17000001 - if the test framework failed to initialize. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Create an {@link Driver} object. - * - * @returns { Driver } the {@link Driver} object. - * @throws { BusinessError } 17000001 - Initialization failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - static create(): Driver; - - /** - * Delay with specified duration. - * - * @param { number } duration The delay duration in milliseconds. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Delay with specified duration. - * - * @param { number } duration The delay duration in milliseconds. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Delay with specified duration. - * - * @param { number } duration - the delay duration in milliseconds, not less than 0. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - delayMs(duration: number): Promise; - - /** - * Find the first matched {@link Component} on current UI. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise } the first matched {@link Component} or undefined. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Find the first matched {@link Component} on current UI. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise } the first matched {@link Component} or undefined. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Find the first matched {@link Component} on current UI. - * - * @param { On } on - the attribute requirements of the target {@link Component}. - * @returns { Promise } the first matched {@link Component} or undefined. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - findComponent(on: On): Promise; - - /** - * Find the first matched {@link UiWindow} window. - * - * @param { WindowFilter } filter The filer condition of the target {@link UiWindow}. - * @returns { Promise } the first matched {@link UiWindow} or undefined. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Find the first matched {@link UiWindow} window. - * - * @param { WindowFilter } filter - the filer condition of the target {@link UiWindow}. - * @returns { Promise } the first matched {@link UiWindow} or undefined. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - findWindow(filter: WindowFilter): Promise; - - /** - * Find the first matched {@link Component} on current UI during the time given. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @param { number } time Duration of finding in milliseconds - * @returns { Promise } the first matched {@link Component} or undefined. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Find the first matched {@link Component} on current UI during the time given. - * - * @param { On } on - the attribute requirements of the target {@link Component}. - * @param { number } time - duration of finding in milliseconds, not less than 0. - * @returns { Promise } the first matched {@link Component} or undefined. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - waitForComponent(on: On, time: number): Promise; - - /** - * Find all the matched {@link Component}s on current UI. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise> } the matched {@link Component}s list. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Find all the matched {@link Component}s on current UI. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise> } the matched {@link Component}s list. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Find all the matched {@link Component}s on current UI. - * - * @param { On } on - the attribute requirements of the target {@link Component}. - * @returns { Promise> } the matched {@link Component}s list. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - findComponents(on: On): Promise>; - - /** - * Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000003 - if the assertion failed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised. - * - * @param { On } on The attribute requirements of the target {@link Component}. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000003 - if the assertion failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised. - * - * @param { On } on - the attribute requirements of the target {@link Component}. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000003 - Assertion failed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - assertComponentExist(on: On): Promise; - - /** - * Press the BACK key. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Press the BACK key. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Press the BACK key. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - pressBack(): Promise; - - /** - * Press the specified key. - * - * @param { number } keyCode the target keyCode. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Press the specified key. - * - * @param { number } keyCode - the target keyCode. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - triggerKey(keyCode: number): Promise; - - /** - * Press two or three key combinations - * - * @param { number } key0 the first keyCode. - * @param { number } key1 the second keyCode. - * @param { number } key2 the third keyCode. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Press two or three key combinations - * - * @param { number } key0 - the first keyCode. - * @param { number } key1 - the second keyCode. - * @param { number } [key2] - the third keyCode,set it default 0 if null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - triggerCombineKeys(key0: number, key1: number, key2?: number): Promise; - - /** - * Click on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Click on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Click on the specified location on the screen. - * - * @param { number } x - the x-coordinate, not less than 0. - * @param { number } y - the y-coordinate, not less than 0. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - click(x: number, y: number): Promise; - - /** - * DoubleClick on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * DoubleClick on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * DoubleClick on the specified location on the screen. - * - * @param { number } x - the x-coordinate, not less than 0. - * @param { number } y - the y-coordinate, not less than 0. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - doubleClick(x: number, y: number): Promise; - - /** - * LongClick on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * LongClick on the specified location on the screen. - * - * @param { number } x The x-coordinate. - * @param { number } y The y-coordinate. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * LongClick on the specified location on the screen. - * - * @param { number } x - the x-coordinate, not less than 0. - * @param { number } y - the y-coordinate, not less than 0. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - longClick(x: number, y: number): Promise; - - /** - * Swipe on the screen between the specified points. - * - * @param { number } startx The x-coordinate of the starting point. - * @param { number } starty The y-coordinate of the starting point. - * @param { number } endx The x-coordinate of the ending point. - * @param { number } endy The y-coordinate of the ending point. - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Swipe on the screen between the specified points. - * - * @param { number } startx The x-coordinate of the starting point. - * @param { number } starty The y-coordinate of the starting point. - * @param { number } endx The x-coordinate of the ending point. - * @param { number } endy The y-coordinate of the ending point. - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Swipe on the screen between the specified points. - * - * @param { number } startx - the x-coordinate of the starting point, not less than 0. - * @param { number } starty - the y-coordinate of the starting point, not less than 0. - * @param { number } endx - the x-coordinate of the ending point, not less than 0. - * @param { number } endy - the y-coordinate of the ending point, not less than 0. - * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - swipe(startx: number, starty: number, endx: number, endy: number, speed?: number): Promise; - - /** - * Drag on the screen between the specified points. - * - * @param { number } startx The x-coordinate of the starting point. - * @param { number } starty The y-coordinate of the starting point. - * @param { number } endx The x-coordinate of the ending point. - * @param { number } endy The y-coordinate of the ending point. - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Drag on the screen between the specified points. - * - * @param { number } startx - the x-coordinate of the starting point, not less than 0. - * @param { number } starty - the y-coordinate of the starting point, not less than 0. - * @param { number } endx - the x-coordinate of the ending point, not less than 0. - * @param { number } endy - the y-coordinate of the ending point, not less than 0. - * @param { number } [speed] the speed of drag(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - drag(startx: number, starty: number, endx: number, endy: number, speed?: number): Promise; - - /** - * Capture current screen and save as picture which PNG format. - * - * @param { string } savePath the path where to store the picture. - * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Capture current screen and save as picture which PNG format. - * - * @param { string } savePath - the path where to store the picture, must be in the application sandbox directory. - * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - screenCap(savePath: string): Promise; - - /** - * Set the rotation of the device display. - * - * @param { DisplayRotation } rotation The target rotation to set. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Set the rotation of the device display. - * - * @param { DisplayRotation } rotation - the target rotation to set. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - setDisplayRotation(rotation: DisplayRotation): Promise; - - /** - * Get the rotation of the device display. - * - * @returns { Promise } the current display rotation. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the rotation of the device display. - * - * @returns { Promise } the current display rotation. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getDisplayRotation(): Promise; - - /** - * Enable/disable the rotation of device display. - * - * @param { boolean } enabled Enable the rotation or not. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Enable/disable the rotation of device display. - * - * @param { boolean } enabled - enable the rotation or not. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - setDisplayRotationEnabled(enabled: boolean): Promise; - - /** - * Get the size of the device display. - * - * @returns { Promise } the size of the device display. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the size of the device display. - * - * @returns { Promise } the size of the device display. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getDisplaySize(): Promise; - - /** - * Get the density of the device display. - * - * @returns { Promise } the density of the device display. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the density of the device display. - * - * @returns { Promise } the density of the device display. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getDisplayDensity(): Promise; - - /** - * Wake up the device display. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Wake up the device display. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - wakeUpDisplay(): Promise; - - /** - * Press the home key. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Press the home key. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - pressHome(): Promise; - - /** - * Wait for the UI become idle. - * - * @param { number } idleTime the threshold of UI idle time, in millisecond. - * @param { number } timeout The maximum time to wait for idle, in millisecond. - * @returns { Promise } true if wait for idle succeed in the timeout, false otherwise. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Wait for the UI become idle. - * - * @param { number } idleTime - the threshold of UI idle time, in millisecond, not less than 0. - * @param { number } timeout - the maximum time to wait for idle, in millisecond, not less than 0. - * @returns { Promise } true if wait for idle succeed in the timeout, false otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - waitForIdle(idleTime: number, timeout: number): Promise; - - /** - * Inject fling on the device display. - * - * @param { Point } from The coordinate point where the finger touches the screen. - * @param { Point } to The coordinate point where the finger leaves the screen. - * @param { number } stepLen the length of each step, in pixels. - * @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Inject fling on the device display. - * - * @param { Point } from The coordinate point where the finger touches the screen. - * @param { Point } to The coordinate point where the finger leaves the screen. - * @param { number } stepLen the length of each step, in pixels. - * @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @since 10 - * @test - */ - /** - * Inject fling on the device display. - * - * @param { Point } from - the coordinate point where the finger touches the screen. - * @param { Point } to - the coordinate point where the finger leaves the screen. - * @param { number } stepLen - the length of each step, in pixels. - * @param { number } [speed] - the speed of fling(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - fling(from: Point, to: Point, stepLen: number, speed: number): Promise; - - /** - * Inject multi-pointer action on the device display. - * - * @param { PointerMatrix } pointers The two-dimensional array of pointers to inject. - * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } true if the operation finished, false - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Inject multi-pointer action on the device display. - * - * @param { PointerMatrix } pointers - the two-dimensional array of pointers to inject. - * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. - * @returns { Promise } true if the operation finished, false - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - injectMultiPointerAction(pointers: PointerMatrix, speed?: number): Promise; - - /** - * Inject fling on the device display. - * - * @param { UiDirection } direction The direction of this action. - * @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Inject fling on the device display. - * - * @param { UiDirection } direction - the direction of this action. - * @param { number } speed - the speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - /** - * Inject fling on the device display. - * - * @param { UiDirection } direction - the direction of this action. - * @param { number } speed - the speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 12 - * @test - */ - fling(direction: UiDirection, speed: number): Promise; - - /** - * Click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. - * - * @param { Point } p The coordinate of the specified location. - * @param { MouseButton } btnId The button of Mouse. - * @param { number } key1 the first keyCode. - * @param { number } key2 the second keyCode. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. - * - * @param { Point } p - the coordinate of the specified location. - * @param { MouseButton } btnId - the button of Mouse. - * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. - * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseClick(p: Point, btnId: MouseButton, key1?: number, key2?: number): Promise; - - /** - * Move the mouse cursor to the specified location. - * - * @param { Point } p The coordinate of the specified location. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Move the mouse cursor to the specified location. - * - * @param { Point } p - the coordinate of the specified location. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseMoveTo(p: Point): Promise; - - /** - * The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary. - * - * @param { Point } p The coordinate of the specified location. - * @param { boolean } down Whether the mouse wheel rolls down. - * @param { number } d The number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels. - * @param { number } key1 the first keyCode. - * @param { number } key2 the second keyCode. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary. - * - * @param { Point } p - the coordinate of the specified location. - * @param { boolean } down - whether the mouse wheel rolls down. - * @param { number } d - the number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels. - * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. - * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseScroll(p: Point, down: boolean, d: number, key1?: number, key2?: number): Promise; - /** - * The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary. - * - * @param { Point } p - the coordinate of the specified location. - * @param { boolean } down - whether the mouse wheel rolls down. - * @param { number } d - the number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels. - * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. - * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. - * @param { number } [speed] - The Speed of mouse wheel rolls(cells per second),ranges from 1 to 500.Set it default 20 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseScroll(p: Point, down: boolean, d: number, key1?: number, key2?: number, speed?: number): Promise; - - /** - * Capture the specified area of current screen and save as picture which PNG format. - * - * @param { string } savePath the path where to store the picture. - * @param { Rect } rect The specified area of current screen, default to full screen. - * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Capture the specified area of current screen and save as picture which PNG format. - * - * @param { string } savePath - the path where to store the picture, must be in the application sandbox directory. - * @param { Rect } [rect] - the specified area of current screen, default to full screen.Set it default if null or undefined. - * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - screenCapture(savePath: string, rect?: Rect): Promise; - - /** - * Create an {@link UIEventObserver} object. - * - * @returns { UIEventObserver } the {@link UIEventObserver} object. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @syscap SystemCapability.Test.UiTest - * @since 10 - * @test - */ - /** - * Create an {@link UIEventObserver} object. - * - * @returns { UIEventObserver } the {@link UIEventObserver} object. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - createUIEventObserver(): UIEventObserver; - - /** - * Double click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. - * - * @param { Point } p - the coordinate of the specified location. - * @param { MouseButton } btnId - the button of Mouse. - * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. - * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseDoubleClick(p: Point, btnId: MouseButton, key1?: number, key2?: number): Promise; - - /** - * Long click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. - * - * @param { Point } p - the coordinate of the specified location. - * @param { MouseButton } btnId - the button of Mouse. - * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. - * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseLongClick(p: Point, btnId: MouseButton, key1?: number, key2?: number): Promise; - - /** - * Swipe on the screen between the specified points with mouse. - * - * @param { Point } from - the starting point. - * @param { Point } to - the ending point. - * @param { number } [speed] - speed of swipe (pixels per second),the value ranges from 200 to 40000.Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseMoveWithTrack(from: Point, to: Point, speed?: number): Promise; - - /** - * Hold down the left mouse button and drag on the screen between the specified points. - * - * @param { Point } from - the starting point. - * @param { Point } to - the ending point. - * @param { number } [speed] - speed of drag (pixels per second),the value ranges from 200 to 40000,Set it default 600 if out of range or null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - mouseDrag(from: Point, to: Point, speed?: number): Promise; - - /** - * Inject text on the specified location. - * - * @param { Point } p - the coordinate of the specified location. - * @param { string } text - the text to inject. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - inputText(p: Point, text: string): Promise; - - /** - * Simulate touchpad multi-finger swipe gestures. - * @param { number } fingers Finger count of touchpad multi-finger swipe, ranges from 3 to 4. - * @param { UiDirection } direction Direction of touchpad multi-finger swipe. - * @param { TouchPadSwipeOptions } [options] Additional options touchpad multi-finger swipe gestures, set its parameters to default values if null or undefined. - * @returns { Promise } - * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 The async function is not called with await. - * @throws { BusinessError } 17000005 This device can not support this action. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - touchPadMultiFingerSwipe(fingers: number, direction: UiDirection, options?: TouchPadSwipeOptions): Promise; - - /** - * Simulate pen click operation. - * @param { Point } point Coordinate of the specified location. - * @returns { Promise } - * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - penClick(point: Point): Promise; - - /** - * Simulate pen long click operation. - * @param { Point } point Coordinate of the specified location. - * @param { number } [pressure] Pressure of pen long click operation, default is 1.0, the value ranges from 0.0 to 1.0. - * @returns { Promise } - * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - penLongClick(point: Point, pressure?: number): Promise; - - /** - * Simulate pen double click operation. - * @param { Point } point Coordinate of the specified location. - * @returns { Promise } - * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - penDoubleClick(point: Point): Promise; - - /** - * Simulate pen swipe operation. - * @param { Point } startPoint Coordinate of the specified location. - * @param { Point } endPoint Coordinate of the specified location. - * @param { number } [speed] Speed(pixels per second) of pen swipe, default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @param { number } [pressure] Pressure of pen swipe operation, default is 1.0, the value ranges from 0.0 to 1.0. - * @returns { Promise } - * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - penSwipe(startPoint: Point, endPoint: Point, speed?: number, pressure?: number): Promise; - - /** - * Inject pen multi-pointer action on the device display. - * @param { PointerMatrix } pointers The two-dimensional array of pointers to inject. - * @param { number } [speed] Speed(pixels per second) of inject pen pointer action, default is 600,the value ranges from 200 to 40000,set it 600 if out of range. - * @param { number } [pressure] Pressure of inject pen pointer action operation, default is 1.0, the value ranges from 0.0 to 1.0. - * @returns { Promise } - * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 The async function is not called with await. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 18 - * @test - */ - injectPenPointerAction(pointers: PointerMatrix, speed?: number, pressure?: number): Promise; -} - -/** - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ -/** - * Represents a window of the ohos application,user can perform operations or query attributes on it. - * - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ -declare class UiWindow { - /** - * Get the bundle name of this {@link UiWindow}. - * - * @returns { Promise } the bundle name. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the bundle name of this {@link UiWindow}. - * - * @returns { Promise } the bundle name. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getBundleName(): Promise; - - /** - * Get the bounds rect of this {@link UiWindow}. - * - * @returns { Promise } the bounds rect object. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the bounds rect of this {@link UiWindow}. - * - * @returns { Promise } the bounds rect object. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ - getBounds(): Promise; - - /** - * Get the title of this {@link UiWindow}. - * - * @returns { Promise } the title value. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the title of this {@link UiWindow}. - * - * @returns { Promise } the title value. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getTitle(): Promise; - - /** - * Get the window mode of this {@link UiWindow}. - * - * @returns { Promise } the {@link WindowMode} object - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the window mode of this {@link UiWindow}. - * - * @returns { Promise } the {@link WindowMode} object - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - getWindowMode(): Promise; - - /** - * Get the focused status of this {@link UiWindow}. - * - * @returns { Promise } the focused status - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the focused status of this {@link UiWindow}. - * - * @returns { Promise } the focused status - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - isFocused(): Promise; - - /** - * Get the active status of this {@link UiWindow}. - * - * @returns { Promise } the actived status - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Get the active status of this {@link UiWindow}. - * - * @returns { Promise } the actived status - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 11 - * @deprecated since 11 - * @useinstead ohos.UiTest.UiWindow#isActive - * @test - */ - isActived(): Promise; - - /** - * Set the focused status of this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Set the focused status of this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - focus(): Promise; - - /** - * Move this {@link UiWindow} to the specified points. - * - * @param { number } x The x coordinate of destination. - * @param { number } y The y coordinate of destination. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Move this {@link UiWindow} to the specified points. - * - * @param { number } x - the x coordinate of destination, not less than 0. - * @param { number } y - the y coordinate of destination, not less than 0. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - moveTo(x: number, y: number): Promise; - - /** - * Resize this {@link UiWindow} to the specified size for the specified direction. - * - * @param { number } wide The expected wide of the window after resizing. - * @param { number } height The expected height of the window after resizing. - * @param { ResizeDirection } direction The expected direction of the window after resizing. - * @returns { Promise } - * @throws { BusinessError } 401 - if the input parameters are invalid. - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Resize this {@link UiWindow} to the specified size for the specified direction. - * - * @param { number } wide - the expected wide of the window after resizing. - * @param { number } height - the expected height of the window after resizing. - * @param { ResizeDirection } direction - the expected direction of the window after resizing. - * @returns { Promise } - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - resize(wide: number, height: number, direction: ResizeDirection): Promise; - - /** - * Change this {@link UiWindow} into split screen mode. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Change this {@link UiWindow} into split screen mode. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - split(): Promise; - - /** - * Maximize this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Maximize this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - maximize(): Promise; - - /** - * Minimize this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Minimize this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - minimize(): Promise; - - /** - * Resume this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Resume this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - resume(): Promise; - - /** - * Close this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - if the async function was not called with await. - * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. - * @throws { BusinessError } 17000005 - if the action is not supported on this window. - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ - /** - * Close this {@link UiWindow}. - * - * @returns { Promise } - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @throws { BusinessError } 17000005 - This operation is not supported. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - close(): Promise; - - /** - * Get the active status of this {@link UiWindow}. - * - * @returns { Promise } the active status. - * @throws { BusinessError } 17000002 - The async function is not called with await. - * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. - * @syscap SystemCapability.Test.UiTest - * @atomicservice - * @since 11 - * @test - */ - isActive(): Promise; -} - -/** - * Represents a two-dimensional array of pointers on the device display, it's used to build a - * multi-finger trace which can be injected with UiDriver. - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ + import { Callback } from './@ohos.base'; + + /** + * Used to initialize the uitest environment at the start of the test + * + * @throws { BusinessError } 17000001 - Initialization failed. + * @syscap SystemCapability.Test.UiTest + * @since 20 + * @arkts 1.2 + * @test + */ + export function loadAndSetUpUiTest(): void {}; + + /** + * Enumerates the string value match pattern. + * + * @enum {number} + * @syscap SystemCapability.Test.UiTest + * @since 8 + */ + /** + * Enumerates the string value match pattern. + * + * @enum {number} + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + */ + /** + * Enumerates the string value match pattern. + * + * @enum {number} + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare enum MatchPattern { + /** + * Equals to a string. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @test + */ + /** + * Equals to a string. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Equals to a string. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + EQUALS = 0, + /** + * Contains a substring. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @test + */ + /** + * Contains a substring. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Contains a substring. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + CONTAINS = 1, + /** + * StartsWith a substring. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @test + */ + /** + * StartsWith a substring. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * StartsWith a substring. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + STARTS_WITH = 2, + /** + * EndsWith a substring. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @test + */ + /** + * EndsWith a substring. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * EndsWith a substring. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + ENDS_WITH = 3, + /** + * Matches the given value using a regular expression, which is case sensitive. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + REG_EXP = 4, + /** + * Matches the given value using a regular expression, which is case insensitive. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + REG_EXP_ICASE = 5, + } + + /** + * Describes the attribute requirements for the target UiComponents. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On + */ + declare class By { + /** + * Specifies the text for the target UiComponent. + * + * @param { string } txt The text value. + * @param { MatchPattern } pattern The {@link MatchPattern} of the text value,default to {@link MatchPattern.EQUALS} + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#text + * @test + */ + text(txt: string, pattern?: MatchPattern): By; + + /** + * Specifies the inspector key of the target UiComponent. + * + * @param { string } key The inspectorKey value. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#id + * @test + */ + key(key: string): By; + + /** + * Specifies the id of the target UiComponent. + * + * @param { number } id The id value. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @test + */ + id(id: number): By; + + /** + * Specifies the type of the target UiComponent. + * + * @param { string } tp The type value. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#type + * @test + */ + type(tp: string): By; + + /** + * Specifies the clickable status of the target UiComponent. + * + * @param { boolean } b The clickable status,default to true. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#clickable + * @test + */ + clickable(b?: boolean): By; + + /** + * Specifies the scrollable status of the target UiComponent. + * + * @param { boolean } b The scrollable status,default to true. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#scrollable + * @test + */ + scrollable(b?: boolean): By; + + /** + * Specifies the enabled status of the target UiComponent. + * + * @param { boolean } b The enabled status,default to true. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#enabled + * @test + */ + enabled(b?: boolean): By; + + /** + * Specifies the focused status of the target UiComponent. + * + * @param { boolean } b The focused status,default to true. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#focused + * @test + */ + focused(b?: boolean): By; + + /** + * Specifies the selected status of the target UiComponent. + * + * @param { boolean } b The selected status,default to true. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#selected + * @test + */ + selected(b?: boolean): By; + + /** + * Requires the target UiComponent which is before another UiComponent that specified by the given {@link By} + * object,used to locate UiComponent relatively. + * + * @param { By } by Describes the attribute requirements of UiComponent which the target one is in front of. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#isBefore + * @test + */ + isBefore(by: By): By; + + /** + * Requires the target UiComponent which is after another UiComponent that specified by the given {@link By} + * object,used to locate UiComponent relatively. + * + * @param { By } by Describes the attribute requirements of UiComponent which the target one is in back of. + * @returns { By } this {@link By} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.On#isAfter + * @test + */ + isAfter(by: By): By; + } + + /** + * Represents a UiComponent of the ohos application,user can perform operations or query attributes on it. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.uitest.Component + * @test + */ + declare class UiComponent { + /** + * Click this {@link UiComponent}. + * + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#click + * @test + */ + click(): Promise; + + /** + * Double click this {@link UiComponent}. + * + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#doubleClick + * @test + */ + doubleClick(): Promise; + + /** + * Long click this {@link UiComponent}. + * + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#longClick + * @test + */ + longClick(): Promise; + + /** + * Get the id attribute value. + * + * @returns { Promise } the id value. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @test + */ + getId(): Promise; + + /** + * Get the inspectorKey attribute value. + * + * @returns { Promise } the inspectorKey value. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#getId + * @test + */ + getKey(): Promise; + + /** + * Get the text attribute value. + * + * @returns { Promise } the text value. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#getText + * @test + */ + getText(): Promise; + + /** + * Get the type name. + * + * @returns { Promise } the type name. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#getType + * @test + */ + getType(): Promise; + + /** + * Get the clickable status of this {@link UiComponent}. + * + * @returns { Promise } the clickable status. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#isClickable + * @test + */ + isClickable(): Promise; + + /** + * Get the scrollable status of this {@link UiComponent}. + * + * @returns { Promise } the scrollable status. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#isScrollable + * @test + */ + isScrollable(): Promise; + + /** + * Get the enabled status of this {@link UiComponent}. + * + * @returns { Promise } the enabled status. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#isEnabled + * @test + */ + isEnabled(): Promise; + + /** + * Get the focused status of this {@link UiComponent}. + * + * @returns { Promise } the focused status. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#isFocused + * @test + */ + isFocused(): Promise; + + /** + * Get the selected status of this {@link UiComponent}. + * + * @returns { Promise } the selected status. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#isSelected + * @test + */ + isSelected(): Promise; + + /** + * Inject text to this {@link UiComponent},applicable to TextInput. + * + * @param { string } text The text to inject. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#inputText + * @test + */ + inputText(text: string): Promise; + + /** + * Scroll on this {@link UiComponent}to find matched {@link UiComponent},applicable to scrollable one. + * + * @param { By } by The attribute requirements of the target {@link UiComponent}. + * @returns { Promise } the found result,or undefined if not found. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Component#scrollSearch + * @test + */ + scrollSearch(by: By): Promise; + } + + /** + * The unified facade of UiTest framework,can be used to find {@link UiComponent},trigger keyEvents,perform + * coordinates-based UI actions,capture screen and so on. + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.uitest.Driver + * @test + */ + declare class UiDriver { + /** + * Create an {@link UiDriver} object. + * + * @returns { UiDriver } the {@link UiDriver} object. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#create + * @test + */ + static create(): UiDriver; + + /** + * Delay with specified duration. + * + * @param { number } duration The delay duration in milliseconds. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#delayMs + * @test + */ + delayMs(duration: number): Promise; + + /** + * Find the first matched {@link UiComponent} on current UI. + * + * @param { By } by The attribute requirements of the target {@link UiComponent}. + * @returns { Promise } the first matched {@link UiComponent} or undefined. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#findComponent + * @test + */ + findComponent(by: By): Promise; + + /** + * Find all the matched {@link UiComponent}s on current UI. + * + * @param { By } by The attribute requirements of the target {@link UiComponent}. + * @returns { Promise> } the matched {@link UiComponent}s list. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#findComponents + * @test + */ + findComponents(by: By): Promise>; + + /** + * Assert the matched {@link UiComponent}s exists on current UI;if not,assertError will be raised. + * + * @param { By } by The attribute requirements of the target {@link UiComponent}. + * @returns { Promise } + * @throws {BusinessError} 401 - if the input parameters are invalid. + * @throws {BusinessError} 17000002 - if the async function was not called with await. + * @throws {BusinessError} 17000003 - if the assertion failed. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#assertComponentExist + * @test + */ + assertComponentExist(by: By): Promise; + + /** + * Press the BACK key. + * + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#pressBack + * @test + */ + pressBack(): Promise; + + /** + * Press the specified key. + * + * @param { number } keyCode the target keyCode. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#triggerKey + * @test + */ + triggerKey(keyCode: number): Promise; + + /** + * Click on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#click + * @test + */ + click(x: number, y: number): Promise; + + /** + * DoubleClick on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#doubleClick + * @test + */ + doubleClick(x: number, y: number): Promise; + + /** + * LongClick on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#longClick + * @test + */ + longClick(x: number, y: number): Promise; + + /** + * Swipe on the screen between the specified points. + * + * @param { number } startx The x-coordinate of the starting point. + * @param { number } starty The y-coordinate of the starting point. + * @param { number } endx The x-coordinate of the ending point. + * @param { number } endy The y-coordinate of the ending point. + * @returns { Promise } + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.UiTest.Driver#swipe + * @test + */ + swipe(startx: number, starty: number, endx: number, endy: number): Promise; + + /** + * Capture current screen and save as picture which PNG format. + * + * @param { string } savePath the path where to store the picture. + * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.uitest.Driver#screenCap + * @test + */ + screenCap(savePath: string): Promise; + } + + /** + * Enumerates the window mode of the tested window. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Enumerates the window mode of the tested window. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare enum WindowMode { + /** + * The test window is a full screen window. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * The test window is a full screen window. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + FULLSCREEN = 0, + /** + * The test window is the first window in the split screen state. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * The test window is the first window in the split screen state. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + PRIMARY = 1, + /** + * The test window is the second window in the split screen state. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * The test window is the second window in the split screen state. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + SECONDARY = 2, + /** + * The test window is a floating window. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * The test window is a floating window. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + FLOATING = 3, + } + + /** + * Enumerates the resize direction for the window. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Enumerates the resize direction for the window. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare enum ResizeDirection { + /** + * Left. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Left. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + LEFT = 0, + /** + * Right. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Right. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + RIGHT = 1, + /** + * Up. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Up. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + UP = 2, + /** + * Down. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Down. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + DOWN = 3, + /** + * Upper left. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Upper left. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + LEFT_UP = 4, + /** + * Lower left. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Lower left. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + LEFT_DOWN = 5, + /** + * Upper right. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Upper right. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + RIGHT_UP = 6, + /** + * Lower right. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Lower right. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + RIGHT_DOWN = 7, + } + + /** + * Enumerates the rotation of the device display. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Enumerates the rotation of the device display. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare enum DisplayRotation { + /** + * Device display does not rotate to display vertically. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Device display does not rotate to display vertically. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + ROTATION_0 = 0, + /** + * Device display rotates 90 degrees clockwise to display horizontally. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Device display rotates 90 degrees clockwise to display horizontally. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + ROTATION_90 = 1, + /** + * Device display rotates clockwise 180 degrees to display vertically in reverse. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Device display rotates clockwise 180 degrees to display vertically in reverse. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + ROTATION_180 = 2, + /** + * Device display rotates 270 degrees clockwise to display horizontally in reverse. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Device display rotates 270 degrees clockwise to display horizontally in reverse. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + ROTATION_270 = 3, + } + + /** + * Represents the point on the device screen. + * + * @typedef Point + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Represents the point on the device screen. + * + * @typedef Point + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + */ + /** + * Represents the point on the device screen. + * + * @typedef Point + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare interface Point { + /** + * The x-coordinate of the coordinate point. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The x-coordinate of the coordinate point. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + */ + /** + * The x-coordinate of the coordinate point. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 11 + */ + /** + * The x-coordinate of the coordinate point. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 + */ + x: number; + /** + * The y-coordinate of the coordinate point. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The y-coordinate of the coordinate point. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + */ + /** + * The y-coordinate of the coordinate point. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 11 + */ + /** + * The y-coordinate of the coordinate point. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 + */ + y: number; + } + + /** + * Represents the rectangle area on the device screen. + * + * @typedef Rect + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Represents the rectangle area on the device screen. + * + * @typedef Rect + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * Represents the rectangle area on the device screen. + * + * @typedef Rect + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare interface Rect { + /** + * The x-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The x-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * The x-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ + /** + * The x-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 + */ + left: number; + /** + * The y-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The y-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * The y-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ + /** + * The y-coordinate of the top left corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 + */ + top: number; + /** + * The x-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The x-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * The x-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ + /** + * The x-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 + */ + right: number; + /** + * The y-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The y-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * The y-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 12 + */ + /** + * The y-coordinate at the bottom right corner of the rectangle. + * + * @type { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'20','1.2':'20'} + * @arkts 1.1&1.2 + */ + bottom: number; + } + + /** + * Represents filer condition to get the window . + * + * @typedef WindowFilter + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Represents filer condition to get the window . + * + * @typedef WindowFilter + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare interface WindowFilter { + /** + * The package name of the application which the window belongs to. + * + * @type { ?string } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The package name of the application which the window belongs to. + * + * @type { ?string } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + bundleName?: string; + + /** + * The title of the window. + * + * @type { ?string } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The title of the window. + * + * @type { ?string } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + title?: string; + + /** + * The focal state of the window. + * + * @type { ?boolean } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The focal state of the window. + * + * @type { ?boolean } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + focused?: boolean; + + /** + * The active state of the window. + * + * @type { ?boolean } + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * The active state of the window. + * + * @type { ?boolean } + * @syscap SystemCapability.Test.UiTest + * @deprecated since 11 + * @useinstead ohos.UiTest.WindowFilter#active + */ + actived?: boolean; + + /** + * The active state of the window. + * + * @type { ?boolean } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + active?: boolean; + } + + /** + * Represents the information of an UI element, can be a component or window. + * + * @typedef UIElementInfo + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Represents the information of an UI element, can be a component or window. + * + * @typedef UIElementInfo + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare interface UIElementInfo { + /** + * The bundle name of the host application. + * @type { string } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * The bundle name of the host application. + * @type { string } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + readonly bundleName: string; + /** + * The component type, set it as 'window' if it's a window. + * @type { string } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * The component type, set it as 'window' if it's a window. + * @type { string } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + readonly type: string; + /** + * The text of component, set it as window's title if it's a window. + * @type { string } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * The text of component, set it as window's title if it's a window. + * @type { string } + * @readonly + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + readonly text: string; + } + + /** + * Observer to monitor UI events. + * + * @typedef UIEventObserver + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Observer to monitor UI events. + * + * @typedef UIEventObserver + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare interface UIEventObserver { /** - * Represents a two-dimensional array of pointers on the device display, it's used to build a - * multi-finger trace which can be injected with UiDriver. - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ -declare class PointerMatrix { - /** - * Create an {@link PointerMatrix} object. - * - * @param { number } fingers The number of fingers. - * @param { number } steps The number of steps of each finger trace. - * @returns { PointerMatrix } the {@link PointerMatrix} object. + * Listen for toast show once + * + * @param { 'toastShow' } type 'toastShow'. + * @param { Callback } callback function, returns the monitored UIElementInfo. * @throws { BusinessError } 401 - if the input parameters are invalid. * @syscap SystemCapability.Test.UiTest - * @since 9 + * @since 10 * @test */ /** - * Create an {@link PointerMatrix} object. - * - * @param { number } fingers - The number of fingers, ranges from 1 to 10. - * @param { number } steps - The number of steps of each finger trace, ranges from 1 to 1000. - * @returns { PointerMatrix } the {@link PointerMatrix} object. + * Listen for toast show once + * + * @param { 'toastShow' } type -'toastShow'. + * @param { Callback } callback - function, returns the monitored UIElementInfo. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Test.UiTest - * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} * @test + * @arkts 1.1&1.2 */ - static create(fingers: number, steps: number): PointerMatrix; + once(type: 'toastShow', callback: Callback): void; /** - * Set the point value of an element in the PointerMatrix. - * - * @param { number } finger The index of target finger to set. - * @param { number } step The index of target step to set. - * @param { Point } point The coordinate of target step to set. + * Listen for dialog show once + * + * @param { 'dialogShow' } type 'dialogShow'. + * @param { Callback } callback function, returns the monitored UIElementInfo. * @throws { BusinessError } 401 - if the input parameters are invalid. * @syscap SystemCapability.Test.UiTest - * @since 9 + * @since 10 * @test */ /** - * Set the point value of an element in the PointerMatrix. - * - * @param { number } finger - the index of target finger to set. - * @param { number } step - the index of target step to set. - * @param { Point } point - the coordinate of target step to set. + * Listen for dialog show once + * + * @param { 'dialogShow' } type - 'dialogShow'. + * @param { Callback } callback - function, returns the monitored UIElementInfo. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} * @test + * @arkts 1.1&1.2 */ - setPoint(finger: number, step: number, point: Point): void; -} - -/** - * The static builder for building {@link By}object conveniently,usage example:BY.text('txt').enabled(true). - * - * @syscap SystemCapability.Test.UiTest - * @since 8 - * @deprecated since 9 - * @useinstead ohos.uitest.ON - * @test - */ -declare const BY: By; - -/** - * The static builder for building {@link On}object conveniently,usage example:ON.text('txt').enabled(true). - * - * @syscap SystemCapability.Test.UiTest - * @since 9 - * @test - */ -/** - * The static builder for building {@link On}object conveniently,usage example:ON.text('txt').enabled(true). - * - * @syscap SystemCapability.Test.UiTest - * @crossplatform - * @atomicservice - * @since 11 - * @test - */ -declare const ON: On; + once(type: 'dialogShow', callback: Callback): void; + } + + /** + * Enumerates the direction for the UI operation . + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @since 10 + */ + /** + * Enumerates the direction for the UI operation . + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * Enumerates the direction for the UI operation . + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare enum UiDirection { + /** + * Left. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Left. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Left. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + LEFT = 0, + /** + * Right. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Right. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Right. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + RIGHT = 1, + /** + * Up. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Up. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Up. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + UP = 2, + /** + * Down. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Down. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Down. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + DOWN = 3, + } + + /** + * Enumerates the id of the button on the mouse. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @since 10 + */ + /** + * Enumerates the id of the button on the mouse. + * + * @enum { number } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare enum MouseButton { + /** + * Left button of the mouse. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Left button of the mouse. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + MOUSE_BUTTON_LEFT = 0, + /** + * Right button of the mouse.. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Right button of the mouse.. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + MOUSE_BUTTON_RIGHT = 1, + /** + * MIDDLE button of the mouse. + * + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * MIDDLE button of the mouse. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + MOUSE_BUTTON_MIDDLE = 2, + } + + /** + * Additional options touchpad multi-finger swipe gestures. + * @interface TouchPadSwipeOptions + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare interface TouchPadSwipeOptions { + /** + * Whether stay for 1 second and lift up after swipe, default is false. + * @type { ?boolean } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + stay?: boolean; + + /** + * Speed(pixels per second) of touchpad multi-finger swipe, default is 2000, the value ranges from 200 to 40000,set it 2000 if out of range. + * @type { ?number } + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + speed?: number; + } + + /** + * Describes the attribute requirements for the target Components. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + */ + /** + * Describes the attribute requirements for the target Components. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + */ + /** + * Describes the attribute requirements for the target Components. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + */ + declare class On { + /** + * Specifies the text for the target Component. + * + * @param { string } txt The text value. + * @param { MatchPattern } pattern The {@link MatchPattern} of the text value, default to {@link MatchPattern.EQUALS} + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the text for the target Component. + * + * @param { string } txt The text value. + * @param { MatchPattern } pattern The {@link MatchPattern} of the text value, default to {@link MatchPattern.EQUALS} + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the text for the target Component. + * + * @param { string } txt - the text value. + * @param { MatchPattern } [pattern] - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + text(txt: string, pattern?: MatchPattern): On; + + /** + * Specifies the id of the target Component. + * + * @param { string } id The id value. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the id of the target Component. + * + * @param { string } id The id value. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the id of the target Component. + * + * @param { string } id - the id value. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + id(id: string): On; + + /** + * Specifies the type of the target Component. + * + * @param { string } tp The type value. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the type of the target Component. + * + * @param { string } tp The type value. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the type of the target Component. + * + * @param { string } tp - The type value. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + type(tp: string): On; + + /** + * Specifies the clickable status of the target Component. + * + * @param { boolean } b The clickable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the clickable status of the target Component. + * + * @param { boolean } b The clickable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the clickable status of the target Component. + * + * @param { boolean } [b] - the clickable status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + clickable(b?: boolean): On; + + /** + * Specifies the longClickable status of the target Component. + * + * @param { boolean } b The clickable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the longClickable status of the target Component. + * + * @param { boolean } b The clickable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the longClickable status of the target Component. + * + * @param { boolean } [b] - the longClickable status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + longClickable(b?: boolean): On; + + /** + * Specifies the scrollable status of the target Component. + * + * @param { boolean } b The scrollable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the scrollable status of the target Component. + * + * @param { boolean } b The scrollable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the scrollable status of the target Component. + * + * @param { boolean } [b] - the scrollable status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + scrollable(b?: boolean): On; + + /** + * Specifies the enabled status of the target Component. + * + * @param { boolean } b The enabled status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the enabled status of the target Component. + * + * @param { boolean } b The enabled status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the enabled status of the target Component. + * + * @param { boolean } [b] - the enabled status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + enabled(b?: boolean): On; + + /** + * Specifies the focused status of the target Component. + * + * @param { boolean } b The focused status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the focused status of the target Component. + * + * @param { boolean } b The focused status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the focused status of the target Component. + * + * @param { boolean } [b] - the focused status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + focused(b?: boolean): On; + + /** + * Specifies the selected status of the target Component. + * + * @param { boolean } b The selected status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the selected status of the target Component. + * + * @param { boolean } b The selected status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the selected status of the target Component. + * + * @param { boolean } [b] the - selected status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + selected(b?: boolean): On; + + /** + * Specifies the checked status of the target Component. + * + * @param { boolean } b The checked status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the checked status of the target Component. + * + * @param { boolean } b The checked status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the checked status of the target Component. + * + * @param { boolean } [b] - the checked status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + checked(b?: boolean): On; + + /** + * Specifies the checkable status of the target Component. + * + * @param { boolean } b The checkable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Specifies the checkable status of the target Component. + * + * @param { boolean } b The checkable status,default to true. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Specifies the checkable status of the target Component. + * + * @param { boolean } [b] - the checkable status.Set it default true if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. 1. Incorrect parameter types; 2. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + checkable(b?: boolean): On; + + /** + * Requires that the target Component which is before another Component that specified by the given {@link On} + * object,used to locate Component relatively. + * + * @param { On } on Describes the attribute requirements of Component which the target one is in front of. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Requires that the target Component which is before another Component that specified by the given {@link On} + * object,used to locate Component relatively. + * + * @param { On } on - describes the attribute requirements of Component which the target one is in front of. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isBefore(on: On): On; + + /** + * Requires that the target Component which is after another Component that specified by the given {@link On} + * object,used to locate Component relatively. + * + * @param { On } on Describes the attribute requirements of Component which the target one is in back of. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Requires that the target Component which is after another Component that specified by the given {@link On} + * object,used to locate Component relatively. + * + * @param { On } on - describes the attribute requirements of Component which the target one is in back of. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isAfter(on: On): On; + + /** + * Requires that the target Component which is inside of another Component that specified by the given {@link On} + * object,used to locate Component relatively. + * + * @param { On } on Describes the attribute requirements of Component which the target one is inside of. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Requires that the target Component which is inside of another Component that specified by the given {@link On} + * object,used to locate Component relatively. + * + * @param { On } on - describes the attribute requirements of Component which the target one is inside of. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + within(on: On): On; + + /** + * Specifies the bundleName of the application which the window that the target Component is located belongs. + * + * @param { string } bundleName The bundleName of the specified window. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Specifies the bundleName of the application which the window that the target Component is located belongs. + * + * @param { string } bundleName - the bundleName of the specified window. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + inWindow(bundleName: string): On; + + /** + * Specifies the description for the target Component. + * + * @param { string } val - the description value. + * @param { MatchPattern } [pattern] - the {@link MatchPattern} of description value,set it default {@link MatchPattern.EQUALS} if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + description(val: string, pattern?: MatchPattern): On; + /** + * Specifies the id of the target Component. + * + * @param { string } id - the id value. + * @param { MatchPattern } pattern - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + id(id: string, pattern: MatchPattern): On; + /** + * Specifies the type of the target Component. + * + * @param { string } tp - The type value. + * @param { MatchPattern } pattern - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + type(tp: string, pattern: MatchPattern): On; + /** + * Specifies the hint for the target Component. + * + * @param { string } val - the hint value. + * @param { MatchPattern } [pattern] - the {@link MatchPattern} of the text value,Set it default {@link MatchPattern.EQUALS} if null or undefined. + * @returns { On } this {@link On} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + hint(val: string, pattern?: MatchPattern): On; + } + + /** + * Represents an Component of the ohos application,user can perform operations or query attributes on it. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Represents an Component of the ohos application,user can perform operations or query attributes on it. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Represents an Component of the ohos application,user can perform operations or query attributes on it. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare class Component { + /** + * Click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + click(): Promise; + + /** + * Double click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Double click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Double click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + doubleClick(): Promise; + + /** + * Long click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Long click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Long click this {@link Component}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + longClick(): Promise; + + /** + * Get the id attribute value. + * + * @returns { Promise } the id value. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the id attribute value. + * + * @returns { Promise } the id value. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the id attribute value. + * + * @returns { Promise } the id value. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getId(): Promise; + + /** + * Get the text attribute value. + * + * @returns { Promise } the text value. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the text attribute value. + * + * @returns { Promise } the text value. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the text attribute value. + * + * @returns { Promise } the text value. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getText(): Promise; + + /** + * Get the type name. + * + * @returns { Promise } the type name. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the type name. + * + * @returns { Promise } the type name. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the type name. + * + * @returns { Promise } the type name. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getType(): Promise; + + /** + * Get the clickable status of this {@link Component}. + * + * @returns { Promise } the clickable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the clickable status of this {@link Component}. + * + * @returns { Promise } the clickable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the clickable status of this {@link Component}. + * + * @returns { Promise } the clickable status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isClickable(): Promise; + + /** + * Get the longClickable status of this {@link Component}. + * + * @returns { Promise } the longClickable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the longClickable status of this {@link Component}. + * + * @returns { Promise } the longClickable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the clickable status of this {@link Component}. + * + * @returns { Promise } the clickable status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isLongClickable(): Promise; + + /** + * Get the scrollable status of this {@link Component}. + * + * @returns { Promise } the scrollable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the scrollable status of this {@link Component}. + * + * @returns { Promise } the scrollable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the scrollable status of this {@link Component}. + * + * @returns { Promise } the scrollable status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isScrollable(): Promise; + + /** + * Get the enabled status of this {@link Component}. + * + * @returns { Promise } the enabled status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the enabled status of this {@link Component}. + * + * @returns { Promise } the enabled status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the enabled status of this {@link Component}. + * + * @returns { Promise } the enabled status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isEnabled(): Promise; + + /** + * Get the focused status of this {@link Component}. + * + * @returns { Promise } the focused status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the focused status of this {@link Component}. + * + * @returns { Promise } the focused status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the focused status of this {@link Component}. + * + * @returns { Promise } the focused status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isFocused(): Promise; + + /** + * Get the selected status of this {@link Component}. + * + * @returns { Promise } the selected status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the selected status of this {@link Component}. + * + * @returns { Promise } the selected status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the selected status of this {@link Component}. + * + * @returns { Promise } the selected status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isSelected(): Promise; + + /** + * Get the checked status of this {@link Component}. + * + * @returns { Promise } the checked status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the checked status of this {@link Component}. + * + * @returns { Promise } the checked status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the checked status of this {@link Component}. + * + * @returns { Promise } the checked status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isChecked(): Promise; + + /** + * Get the checkable status of this {@link Component}. + * + * @returns { Promise } the checkable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the checkable status of this {@link Component}. + * + * @returns { Promise } the checkable status. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the checkable status of this {@link Component}. + * + * @returns { Promise } the checkable status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isCheckable(): Promise; + + /** + * Inject text to this {@link Component},applicable to TextInput. + * + * @param { string } text The text to inject. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Inject text to this {@link Component},applicable to TextInput. + * + * @param { string } text The text to inject. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Inject text to this {@link Component},applicable to TextInput. + * + * @param { string } text - the text to inject. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + inputText(text: string): Promise; + + /** + * Clear text of this {@link Component},applicable to TextInput. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Clear text of this {@link Component},applicable to TextInput. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Clear text of this {@link Component},applicable to TextInput. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + clearText(): Promise; + + /** + * Scroll on this {@link Component} to the top,applicable to scrollable one. + * + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Scroll on this {@link Component} to the top,applicable to scrollable one. + * + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Scroll on this {@link Component} to the top,applicable to scrollable one. + * + * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000.Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + scrollToTop(speed?: number): Promise; + + /** + * Scroll on this {@link Component} to the bottom,applicable to scrollable one. + * + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Scroll on this {@link Component} to the bottom,applicable to scrollable one. + * + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Scroll on this {@link Component} to the bottom,applicable to scrollable one. + * + * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; 2. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + scrollToBottom(speed?: number): Promise; + + /** + * Get the bounds rect of this {@link Component}. + * + * @returns { Promise } the bounds rect object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the bounds rect of this {@link Component}. + * + * @returns { Promise } the bounds rect object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Get the bounds rect of this {@link Component}. + * + * @returns { Promise } the bounds rect object. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getBounds(): Promise; + + /** + * Get the boundsCenter of this {@link Component}. + * + * @returns { Promise } the boundsCenter object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the boundsCenter of this {@link Component}. + * + * @returns { Promise } the boundsCenter object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Get the boundsCenter of this {@link Component}. + * + * @returns { Promise } the boundsCenter object. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getBoundsCenter(): Promise; + + /** + * Drag this {@link Component} to the bounds rect of target Component. + * + * @param { Component } target The target {@link Component}. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Drag this {@link Component} to the bounds rect of target Component. + * + * @param { Component } target - the target {@link Component}. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + dragTo(target: Component): Promise; + + /** + * Pinch enlarge this {@link Component} to the target scale. + * + * @param { number } scale The scale of the pinch enlarge this {@link Component}'s size. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Pinch enlarge this {@link Component} to the target scale. + * + * @param { number } scale - the scale of the pinch enlarge this {@link Component}'s size, ranges greater than 1. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + pinchOut(scale: number): Promise; + + /** + * Pinch shrink this {@link Component} to the target scale. + * + * @param { number } scale The scale of the pinch shrink this {@link Component}'s size. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Pinch shrink this {@link Component} to the target scale. + * + * @param { number } scale - the scale of the pinch shrink this {@link Component}'s size, ranges from 0 to 1. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + pinchIn(scale: number): Promise; + + /** + * Get the description attribute value. + * + * @returns { Promise } the description value. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getDescription(): Promise; + /** + * Get the hint attribute value. + * + * @returns { Promise } the hint value. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getHint(): Promise; + + /** + * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise } the found result,or undefined if not found. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise } the found result,or undefined if not found. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise } the found result,or undefined if not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ + scrollSearch(on: On): Promise; -export { - UiComponent, - UiDriver, - Component, - Driver, - UiWindow, - ON, - On, - BY, - By, - MatchPattern, - DisplayRotation, - ResizeDirection, - WindowMode, - Point, - WindowFilter, - Rect, - PointerMatrix, - UiDirection, - MouseButton, - UIElementInfo, - UIEventObserver, - TouchPadSwipeOptions -}; + /** + * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise } the found result, or null if not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + scrollSearch(on: On): Promise; + + /** + * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @param { boolean } [vertical] - Whether the swipe direction is vertical, default is true. + * @param { number } [offset] - Offset from the swipe start/end point to the component border, default is 80. + * @returns { Promise } the found result,or undefined if not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 18 + * @test + */ + scrollSearch(on: On, vertical?: boolean, offset?: number): Promise; + + /** + * Scroll on this {@link Component}to find matched {@link Component},applicable to scrollable one. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @param { boolean } [vertical] - Whether the swipe direction is vertical, default is true. + * @param { number } [offset] - Offset from the swipe start/end point to the component border, default is 80. + * @returns { Promise } the found result,or null if not found. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + scrollSearch(on: On, vertical?: boolean, offset?: number): Promise; + } + + /** + * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform + * coordinates-based UI actions,capture screen and so on. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform + * coordinates-based UI actions,capture screen and so on. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * The unified facade of UiTest framework,can be used to find {@link Component},trigger keyEvents,perform + * coordinates-based UI actions,capture screen and so on. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare class Driver { + /** + * Create an {@link Driver} object. + * + * @returns { Driver } the {@link Driver} object. + * @throws { BusinessError } 17000001 - if the test framework failed to initialize. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Create an {@link Driver} object. + * + * @returns { Driver } the {@link Driver} object. + * @throws { BusinessError } 17000001 - if the test framework failed to initialize. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Create an {@link Driver} object. + * + * @returns { Driver } the {@link Driver} object. + * @throws { BusinessError } 17000001 - Initialization failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + static create(): Driver; + + /** + * Delay with specified duration. + * + * @param { number } duration The delay duration in milliseconds. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Delay with specified duration. + * + * @param { number } duration The delay duration in milliseconds. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Delay with specified duration. + * + * @param { number } duration - the delay duration in milliseconds, not less than 0. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + delayMs(duration: number): Promise; + + /** + * Find the first matched {@link Component} on current UI. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Find the first matched {@link Component} on current UI. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Find the first matched {@link Component} on current UI. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ + findComponent(on: On): Promise; + /** + * Find the first matched {@link Component} on current UI. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + findComponent(on: On): Promise; + + /** + * Find the first matched {@link UiWindow} window. + * + * @param { WindowFilter } filter The filer condition of the target {@link UiWindow}. + * @returns { Promise } the first matched {@link UiWindow} or undefined. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Find the first matched {@link UiWindow} window. + * + * @param { WindowFilter } filter - the filer condition of the target {@link UiWindow}. + * @returns { Promise } the first matched {@link UiWindow} or undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + findWindow(filter: WindowFilter): Promise; + /** + * Find the first matched {@link UiWindow} window. + * + * @param { WindowFilter } filter - the filer condition of the target {@link UiWindow}. + * @returns { Promise } the first matched {@link UiWindow} or undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + findWindow(filter: WindowFilter): Promise; + + /** + * Find the first matched {@link Component} on current UI during the time given. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @param { number } time Duration of finding in milliseconds + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Find the first matched {@link Component} on current UI during the time given. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @param { number } time - duration of finding in milliseconds, not less than 0. + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + waitForComponent(on: On, time: number): Promise; + /** + * Find the first matched {@link Component} on current UI during the time given. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @param { number } time - duration of finding in milliseconds, not less than 0. + * @returns { Promise } the first matched {@link Component} or undefined. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + waitForComponent(on: On, time: number): Promise; + + /** + * Find all the matched {@link Component}s on current UI. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise> } the matched {@link Component}s list. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Find all the matched {@link Component}s on current UI. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise> } the matched {@link Component}s list. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Find all the matched {@link Component}s on current UI. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise> } the matched {@link Component}s list. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since 11 + * @test + */ + findComponents(on: On): Promise>; + + /** + * Find all the matched {@link Component}s on current UI. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise | null> } the matched {@link Component}s list. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + findComponents(on: On): Promise | null>; + + /** + * Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000003 - if the assertion failed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised. + * + * @param { On } on The attribute requirements of the target {@link Component}. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000003 - if the assertion failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Assert t the matched {@link Component}s exists on current UI;if not,assertError will be raised. + * + * @param { On } on - the attribute requirements of the target {@link Component}. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000003 - Assertion failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + assertComponentExist(on: On): Promise; + + /** + * Press the BACK key. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Press the BACK key. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Press the BACK key. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + pressBack(): Promise; + + /** + * Press the specified key. + * + * @param { number } keyCode the target keyCode. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Press the specified key. + * + * @param { number } keyCode - the target keyCode. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + triggerKey(keyCode: number): Promise; + + /** + * Press two or three key combinations + * + * @param { number } key0 the first keyCode. + * @param { number } key1 the second keyCode. + * @param { number } key2 the third keyCode. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Press two or three key combinations + * + * @param { number } key0 - the first keyCode. + * @param { number } key1 - the second keyCode. + * @param { number } [key2] - the third keyCode,set it default 0 if null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + triggerCombineKeys(key0: number, key1: number, key2?: number): Promise; + + /** + * Click on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Click on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Click on the specified location on the screen. + * + * @param { number } x - the x-coordinate, not less than 0. + * @param { number } y - the y-coordinate, not less than 0. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + click(x: number, y: number): Promise; + + /** + * DoubleClick on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * DoubleClick on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * DoubleClick on the specified location on the screen. + * + * @param { number } x - the x-coordinate, not less than 0. + * @param { number } y - the y-coordinate, not less than 0. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + doubleClick(x: number, y: number): Promise; + + /** + * LongClick on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * LongClick on the specified location on the screen. + * + * @param { number } x The x-coordinate. + * @param { number } y The y-coordinate. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * LongClick on the specified location on the screen. + * + * @param { number } x - the x-coordinate, not less than 0. + * @param { number } y - the y-coordinate, not less than 0. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + longClick(x: number, y: number): Promise; + + /** + * Swipe on the screen between the specified points. + * + * @param { number } startx The x-coordinate of the starting point. + * @param { number } starty The y-coordinate of the starting point. + * @param { number } endx The x-coordinate of the ending point. + * @param { number } endy The y-coordinate of the ending point. + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Swipe on the screen between the specified points. + * + * @param { number } startx The x-coordinate of the starting point. + * @param { number } starty The y-coordinate of the starting point. + * @param { number } endx The x-coordinate of the ending point. + * @param { number } endy The y-coordinate of the ending point. + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Swipe on the screen between the specified points. + * + * @param { number } startx - the x-coordinate of the starting point, not less than 0. + * @param { number } starty - the y-coordinate of the starting point, not less than 0. + * @param { number } endx - the x-coordinate of the ending point, not less than 0. + * @param { number } endy - the y-coordinate of the ending point, not less than 0. + * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + swipe(startx: number, starty: number, endx: number, endy: number, speed?: number): Promise; + + /** + * Drag on the screen between the specified points. + * + * @param { number } startx The x-coordinate of the starting point. + * @param { number } starty The y-coordinate of the starting point. + * @param { number } endx The x-coordinate of the ending point. + * @param { number } endy The y-coordinate of the ending point. + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Drag on the screen between the specified points. + * + * @param { number } startx - the x-coordinate of the starting point, not less than 0. + * @param { number } starty - the y-coordinate of the starting point, not less than 0. + * @param { number } endx - the x-coordinate of the ending point, not less than 0. + * @param { number } endy - the y-coordinate of the ending point, not less than 0. + * @param { number } [speed] the speed of drag(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + drag(startx: number, starty: number, endx: number, endy: number, speed?: number): Promise; + + /** + * Capture current screen and save as picture which PNG format. + * + * @param { string } savePath the path where to store the picture. + * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Capture current screen and save as picture which PNG format. + * + * @param { string } savePath - the path where to store the picture, must be in the application sandbox directory. + * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + screenCap(savePath: string): Promise; + + /** + * Set the rotation of the device display. + * + * @param { DisplayRotation } rotation The target rotation to set. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Set the rotation of the device display. + * + * @param { DisplayRotation } rotation - the target rotation to set. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + setDisplayRotation(rotation: DisplayRotation): Promise; + + /** + * Get the rotation of the device display. + * + * @returns { Promise } the current display rotation. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the rotation of the device display. + * + * @returns { Promise } the current display rotation. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getDisplayRotation(): Promise; + + /** + * Enable/disable the rotation of device display. + * + * @param { boolean } enabled Enable the rotation or not. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Enable/disable the rotation of device display. + * + * @param { boolean } enabled - enable the rotation or not. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + setDisplayRotationEnabled(enabled: boolean): Promise; + + /** + * Get the size of the device display. + * + * @returns { Promise } the size of the device display. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the size of the device display. + * + * @returns { Promise } the size of the device display. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getDisplaySize(): Promise; + + /** + * Get the density of the device display. + * + * @returns { Promise } the density of the device display. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the density of the device display. + * + * @returns { Promise } the density of the device display. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getDisplayDensity(): Promise; + + /** + * Wake up the device display. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Wake up the device display. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + wakeUpDisplay(): Promise; + + /** + * Press the home key. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Press the home key. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + pressHome(): Promise; + + /** + * Wait for the UI become idle. + * + * @param { number } idleTime the threshold of UI idle time, in millisecond. + * @param { number } timeout The maximum time to wait for idle, in millisecond. + * @returns { Promise } true if wait for idle succeed in the timeout, false otherwise. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Wait for the UI become idle. + * + * @param { number } idleTime - the threshold of UI idle time, in millisecond, not less than 0. + * @param { number } timeout - the maximum time to wait for idle, in millisecond, not less than 0. + * @returns { Promise } true if wait for idle succeed in the timeout, false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + waitForIdle(idleTime: number, timeout: number): Promise; + + /** + * Inject fling on the device display. + * + * @param { Point } from The coordinate point where the finger touches the screen. + * @param { Point } to The coordinate point where the finger leaves the screen. + * @param { number } stepLen the length of each step, in pixels. + * @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Inject fling on the device display. + * + * @param { Point } from The coordinate point where the finger touches the screen. + * @param { Point } to The coordinate point where the finger leaves the screen. + * @param { number } stepLen the length of each step, in pixels. + * @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @since 10 + * @test + */ + /** + * Inject fling on the device display. + * + * @param { Point } from - the coordinate point where the finger touches the screen. + * @param { Point } to - the coordinate point where the finger leaves the screen. + * @param { number } stepLen - the length of each step, in pixels. + * @param { number } [speed] - the speed of fling(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + fling(from: Point, to: Point, stepLen: number, speed: number): Promise; + + /** + * Inject multi-pointer action on the device display. + * + * @param { PointerMatrix } pointers The two-dimensional array of pointers to inject. + * @param { number } speed The speed of swipe (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } true if the operation finished, false + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Inject multi-pointer action on the device display. + * + * @param { PointerMatrix } pointers - the two-dimensional array of pointers to inject. + * @param { number } [speed] - the speed of swipe(pixels per second),ranges from 200 to 40000. Set it default 600 if out of range or null or undefined. + * @returns { Promise } true if the operation finished, false + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + injectMultiPointerAction(pointers: PointerMatrix, speed?: number): Promise; + + /** + * Inject fling on the device display. + * + * @param { UiDirection } direction The direction of this action. + * @param { number } speed The speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Inject fling on the device display. + * + * @param { UiDirection } direction - the direction of this action. + * @param { number } speed - the speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since 11 + * @test + */ + /** + * Inject fling on the device display. + * + * @param { UiDirection } direction - the direction of this action. + * @param { number } speed - the speed of fling (pixels per second),default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + fling(direction: UiDirection, speed: number): Promise; + + /** + * Click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. + * + * @param { Point } p The coordinate of the specified location. + * @param { MouseButton } btnId The button of Mouse. + * @param { number } key1 the first keyCode. + * @param { number } key2 the second keyCode. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. + * + * @param { Point } p - the coordinate of the specified location. + * @param { MouseButton } btnId - the button of Mouse. + * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. + * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseClick(p: Point, btnId: MouseButton, key1?: number, key2?: number): Promise; + + /** + * Move the mouse cursor to the specified location. + * + * @param { Point } p The coordinate of the specified location. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Move the mouse cursor to the specified location. + * + * @param { Point } p - the coordinate of the specified location. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseMoveTo(p: Point): Promise; + + /** + * The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary. + * + * @param { Point } p The coordinate of the specified location. + * @param { boolean } down Whether the mouse wheel rolls down. + * @param { number } d The number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels. + * @param { number } key1 the first keyCode. + * @param { number } key2 the second keyCode. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary. + * + * @param { Point } p - the coordinate of the specified location. + * @param { boolean } down - whether the mouse wheel rolls down. + * @param { number } d - the number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels. + * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. + * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseScroll(p: Point, down: boolean, d: number, key1?: number, key2?: number): Promise; + + /** + * The mouse wheel scrolls the specified cell at the specified position, and press the specified key simultaneously if necessary. + * + * @param { Point } p - the coordinate of the specified location. + * @param { boolean } down - whether the mouse wheel rolls down. + * @param { number } d - the number of cells that the mouse wheel scrolls, each cell will make the target point shift 120 pixels. + * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. + * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. + * @param { number } [speed] - The Speed of mouse wheel rolls(cells per second),ranges from 1 to 500.Set it default 20 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseScroll(p: Point, down: boolean, d: number, key1?: number, key2?: number, speed?: number): Promise; + + /** + * Capture the specified area of current screen and save as picture which PNG format. + * + * @param { string } savePath the path where to store the picture. + * @param { Rect } rect The specified area of current screen, default to full screen. + * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Capture the specified area of current screen and save as picture which PNG format. + * + * @param { string } savePath - the path where to store the picture, must be in the application sandbox directory. + * @param { Rect } [rect] - the specified area of current screen, default to full screen.Set it default if null or undefined. + * @returns { Promise } true if screen-capturing and file-storing are completed successfully,false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + screenCapture(savePath: string, rect?: Rect): Promise; + + /** + * Create an {@link UIEventObserver} object. + * + * @returns { UIEventObserver } the {@link UIEventObserver} object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @syscap SystemCapability.Test.UiTest + * @since 10 + * @test + */ + /** + * Create an {@link UIEventObserver} object. + * + * @returns { UIEventObserver } the {@link UIEventObserver} object. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + createUIEventObserver(): UIEventObserver; + + /** + * Double click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. + * + * @param { Point } p - the coordinate of the specified location. + * @param { MouseButton } btnId - the button of Mouse. + * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. + * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseDoubleClick(p: Point, btnId: MouseButton, key1?: number, key2?: number): Promise; + + /** + * Long click on the specified location on the screen with the specified mouse button, and press the specified key simultaneously if necessary. + * + * @param { Point } p - the coordinate of the specified location. + * @param { MouseButton } btnId - the button of Mouse. + * @param { number } [key1] - the first keyCode,set it default 0 if null or undefined. + * @param { number } [key2] - the second keyCode,set it default 0 if null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseLongClick(p: Point, btnId: MouseButton, key1?: number, key2?: number): Promise; + + /** + * Swipe on the screen between the specified points with mouse. + * + * @param { Point } from - the starting point. + * @param { Point } to - the ending point. + * @param { number } [speed] - speed of swipe (pixels per second),the value ranges from 200 to 40000.Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseMoveWithTrack(from: Point, to: Point, speed?: number): Promise; + + /** + * Hold down the left mouse button and drag on the screen between the specified points. + * + * @param { Point } from - the starting point. + * @param { Point } to - the ending point. + * @param { number } [speed] - speed of drag (pixels per second),the value ranges from 200 to 40000,Set it default 600 if out of range or null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + mouseDrag(from: Point, to: Point, speed?: number): Promise; + + /** + * Inject text on the specified location. + * + * @param { Point } p - the coordinate of the specified location. + * @param { string } text - the text to inject. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + inputText(p: Point, text: string): Promise; + + /** + * Simulate touchpad multi-finger swipe gestures. + * @param { number } fingers Finger count of touchpad multi-finger swipe, ranges from 3 to 4. + * @param { UiDirection } direction Direction of touchpad multi-finger swipe. + * @param { TouchPadSwipeOptions } [options] Additional options touchpad multi-finger swipe gestures, set its parameters to default values if null or undefined. + * @returns { Promise } + * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 The async function is not called with await. + * @throws { BusinessError } 17000005 This device can not support this action. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + touchPadMultiFingerSwipe(fingers: number, direction: UiDirection, options?: TouchPadSwipeOptions): Promise; + + /** + * Simulate pen click operation. + * @param { Point } point Coordinate of the specified location. + * @returns { Promise } + * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + penClick(point: Point): Promise; + + /** + * Simulate pen long click operation. + * @param { Point } point Coordinate of the specified location. + * @param { number } [pressure] Pressure of pen long click operation, default is 1.0, the value ranges from 0.0 to 1.0. + * @returns { Promise } + * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + penLongClick(point: Point, pressure?: number): Promise; + + /** + * Simulate pen double click operation. + * @param { Point } point Coordinate of the specified location. + * @returns { Promise } + * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + penDoubleClick(point: Point): Promise; + + /** + * Simulate pen swipe operation. + * @param { Point } startPoint Coordinate of the specified location. + * @param { Point } endPoint Coordinate of the specified location. + * @param { number } [speed] Speed(pixels per second) of pen swipe, default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @param { number } [pressure] Pressure of pen swipe operation, default is 1.0, the value ranges from 0.0 to 1.0. + * @returns { Promise } + * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + penSwipe(startPoint: Point, endPoint: Point, speed?: number, pressure?: number): Promise; + + /** + * Inject pen multi-pointer action on the device display. + * @param { PointerMatrix } pointers The two-dimensional array of pointers to inject. + * @param { number } [speed] Speed(pixels per second) of inject pen pointer action, default is 600,the value ranges from 200 to 40000,set it 600 if out of range. + * @param { number } [pressure] Pressure of inject pen pointer action operation, default is 1.0, the value ranges from 0.0 to 1.0. + * @returns { Promise } + * @throws { BusinessError } 401 Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 The async function is not called with await. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'18','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + injectPenPointerAction(pointers: PointerMatrix, speed?: number, pressure?: number): Promise; + } + + /** + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Represents a window of the ohos application,user can perform operations or query attributes on it. + * + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare class UiWindow { + /** + * Get the bundle name of this {@link UiWindow}. + * + * @returns { Promise } the bundle name. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the bundle name of this {@link UiWindow}. + * + * @returns { Promise } the bundle name. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getBundleName(): Promise; + + /** + * Get the bounds rect of this {@link UiWindow}. + * + * @returns { Promise } the bounds rect object. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the bounds rect of this {@link UiWindow}. + * + * @returns { Promise } the bounds rect object. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getBounds(): Promise; + + /** + * Get the title of this {@link UiWindow}. + * + * @returns { Promise } the title value. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the title of this {@link UiWindow}. + * + * @returns { Promise } the title value. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getTitle(): Promise; + + /** + * Get the window mode of this {@link UiWindow}. + * + * @returns { Promise } the {@link WindowMode} object + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the window mode of this {@link UiWindow}. + * + * @returns { Promise } the {@link WindowMode} object + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + getWindowMode(): Promise; + + /** + * Get the focused status of this {@link UiWindow}. + * + * @returns { Promise } the focused status + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the focused status of this {@link UiWindow}. + * + * @returns { Promise } the focused status + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isFocused(): Promise; + + /** + * Get the active status of this {@link UiWindow}. + * + * @returns { Promise } the actived status + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Get the active status of this {@link UiWindow}. + * + * @returns { Promise } the actived status + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @deprecated since 11 + * @useinstead ohos.UiTest.UiWindow#isActive + * @test + */ + isActived(): Promise; + + /** + * Set the focused status of this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Set the focused status of this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + focus(): Promise; + + /** + * Move this {@link UiWindow} to the specified points. + * + * @param { number } x The x coordinate of destination. + * @param { number } y The y coordinate of destination. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Move this {@link UiWindow} to the specified points. + * + * @param { number } x - the x coordinate of destination, not less than 0. + * @param { number } y - the y coordinate of destination, not less than 0. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + moveTo(x: number, y: number): Promise; + + /** + * Resize this {@link UiWindow} to the specified size for the specified direction. + * + * @param { number } wide The expected wide of the window after resizing. + * @param { number } height The expected height of the window after resizing. + * @param { ResizeDirection } direction The expected direction of the window after resizing. + * @returns { Promise } + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Resize this {@link UiWindow} to the specified size for the specified direction. + * + * @param { number } wide - the expected wide of the window after resizing. + * @param { number } height - the expected height of the window after resizing. + * @param { ResizeDirection } direction - the expected direction of the window after resizing. + * @returns { Promise } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + resize(wide: number, height: number, direction: ResizeDirection): Promise; + + /** + * Change this {@link UiWindow} into split screen mode. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Change this {@link UiWindow} into split screen mode. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + split(): Promise; + + /** + * Maximize this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Maximize this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + maximize(): Promise; + + /** + * Minimize this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Minimize this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + minimize(): Promise; + + /** + * Resume this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Resume this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + resume(): Promise; + + /** + * Close this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - if the async function was not called with await. + * @throws { BusinessError } 17000004 - if the window is invisible or destroyed. + * @throws { BusinessError } 17000005 - if the action is not supported on this window. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Close this {@link UiWindow}. + * + * @returns { Promise } + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @throws { BusinessError } 17000005 - This operation is not supported. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + close(): Promise; + + /** + * Get the active status of this {@link UiWindow}. + * + * @returns { Promise } the active status. + * @throws { BusinessError } 17000002 - The async function is not called with await. + * @throws { BusinessError } 17000004 - The window or component is invisible or destroyed. + * @syscap SystemCapability.Test.UiTest + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + isActive(): Promise; + } + + /** + * Represents a two-dimensional array of pointers on the device display, it's used to build a + * multi-finger trace which can be injected with UiDriver. + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Represents a two-dimensional array of pointers on the device display, it's used to build a + * multi-finger trace which can be injected with UiDriver. + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare class PointerMatrix { + /** + * Create an {@link PointerMatrix} object. + * + * @param { number } fingers The number of fingers. + * @param { number } steps The number of steps of each finger trace. + * @returns { PointerMatrix } the {@link PointerMatrix} object. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Create an {@link PointerMatrix} object. + * + * @param { number } fingers - The number of fingers, ranges from 1 to 10. + * @param { number } steps - The number of steps of each finger trace, ranges from 1 to 1000. + * @returns { PointerMatrix } the {@link PointerMatrix} object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + static create(fingers: number, steps: number): PointerMatrix; + + /** + * Set the point value of an element in the PointerMatrix. + * + * @param { number } finger The index of target finger to set. + * @param { number } step The index of target step to set. + * @param { Point } point The coordinate of target step to set. + * @throws { BusinessError } 401 - if the input parameters are invalid. + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * Set the point value of an element in the PointerMatrix. + * + * @param { number } finger - the index of target finger to set. + * @param { number } step - the index of target step to set. + * @param { Point } point - the coordinate of target step to set. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + setPoint(finger: number, step: number, point: Point): void; + } + + /** + * The static builder for building {@link By}object conveniently,usage example:BY.text('txt').enabled(true). + * + * @syscap SystemCapability.Test.UiTest + * @since 8 + * @deprecated since 9 + * @useinstead ohos.uitest.ON + * @test + */ + declare const BY: By; + + /** + * The static builder for building {@link On}object conveniently,usage example:ON.text('txt').enabled(true). + * + * @syscap SystemCapability.Test.UiTest + * @since 9 + * @test + */ + /** + * The static builder for building {@link On}object conveniently,usage example:ON.text('txt').enabled(true). + * + * @syscap SystemCapability.Test.UiTest + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @test + * @arkts 1.1&1.2 + */ + declare const ON: On; + + /*** if arkts 1.1 */ + export { + UiComponent, + UiDriver, + BY, + By, + }; + /*** endif */ + + export { + Component, + Driver, + UiWindow, + ON, + On, + MatchPattern, + DisplayRotation, + ResizeDirection, + WindowMode, + Point, + WindowFilter, + Rect, + PointerMatrix, + UiDirection, + MouseButton, + UIElementInfo, + UIEventObserver, + TouchPadSwipeOptions + }; + \ No newline at end of file diff --git a/api/@ohos.ability.ability.d.ts b/api/@ohos.ability.ability.d.ts index f09a89c82806750927739c6e190b8dd64f31f89f..f3493daf919a87c824cf16ddbbc7227e99866fa0 100644 --- a/api/@ohos.ability.ability.d.ts +++ b/api/@ohos.ability.ability.d.ts @@ -19,12 +19,12 @@ */ import { DataAbilityHelper as _DataAbilityHelper } from './ability/dataAbilityHelper'; -import { PacMap as _PacMap } from './ability/dataAbilityHelper'; import { DataAbilityOperation as _DataAbilityOperation } from './ability/dataAbilityOperation'; import { DataAbilityResult as _DataAbilityResult } from './ability/dataAbilityResult'; import { AbilityResult as _AbilityResult } from './ability/abilityResult'; import { ConnectOptions as _ConnectOptions } from './ability/connectOptions'; import { StartAbilityParameter as _StartAbilityParameter } from './ability/startAbilityParameter'; +import { PacMap as _PacMap } from './ability/dataAbilityHelper'; /** * The class of an ability. diff --git a/api/@ohos.abilityAccessCtrl.d.ts b/api/@ohos.abilityAccessCtrl.d.ts index 11233217060e2adbfcec71f62c9e6405b3c0bfa3..aea2e98aabe804af68b0d00964f3cafcf2d79e12 100644 --- a/api/@ohos.abilityAccessCtrl.d.ts +++ b/api/@ohos.abilityAccessCtrl.d.ts @@ -22,6 +22,9 @@ import { AsyncCallback, Callback } from './@ohos.base'; import { Permissions } from './permissions'; import type _Context from './application/Context'; import type _PermissionRequestResult from './security/PermissionRequestResult'; +/*** if arkts 1.1 */ +import { int } from '@ohos.base'; +/*** endif */ /** * @namespace abilityAccessCtrl @@ -39,7 +42,8 @@ import type _PermissionRequestResult from './security/PermissionRequestResult'; * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace abilityAccessCtrl { /** @@ -64,7 +68,8 @@ declare namespace abilityAccessCtrl { * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function createAtManager(): AtManager; @@ -81,7 +86,8 @@ declare namespace abilityAccessCtrl { * @interface AtManager * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AtManager { /** @@ -111,20 +117,21 @@ declare namespace abilityAccessCtrl { /** * Checks whether a specified application has been granted the given permission synchronously. * - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { GrantStatus } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 12100001 - Invalid parameter. The tokenID is 0, or the permissionName exceeds 256 characters. * @syscap SystemCapability.Security.AccessToken - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - verifyAccessTokenSync(tokenID: number, permissionName: Permissions): GrantStatus; + verifyAccessTokenSync(tokenID: int, permissionName: Permissions): GrantStatus; /** * Checks whether a specified application has been granted the given permission. * - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { Promise } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. @@ -136,7 +143,7 @@ declare namespace abilityAccessCtrl { * Checks whether a specified application has been granted the given permission. * On the cross-platform, this function can be used to check the permission grant status for the current application only. * - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { Promise } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. @@ -149,7 +156,7 @@ declare namespace abilityAccessCtrl { * Checks whether a specified application has been granted the given permission. * On the cross-platform, this function can be used to check the permission grant status for the current application only. * - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { Promise } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. @@ -157,15 +164,16 @@ declare namespace abilityAccessCtrl { * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - checkAccessToken(tokenID: number, permissionName: Permissions): Promise; + checkAccessToken(tokenID: int, permissionName: Permissions): Promise; /** * Checks whether a specified application has been granted the given permission. * On the cross-platform, this function can be used to check the permission grant status for the current application only. * - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { GrantStatus } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. @@ -178,7 +186,7 @@ declare namespace abilityAccessCtrl { * Checks whether a specified application has been granted the given permission. * On the cross-platform, this function can be used to check the permission grant status for the current application only. * - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be verified. * @returns { GrantStatus } Returns permission verify result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. @@ -186,9 +194,10 @@ declare namespace abilityAccessCtrl { * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - checkAccessTokenSync(tokenID: number, permissionName: Permissions): GrantStatus; + checkAccessTokenSync(tokenID: int, permissionName: Permissions): GrantStatus; /** * Requests certain permissions from the user. @@ -230,7 +239,8 @@ declare namespace abilityAccessCtrl { * @stagemodelonly * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ requestPermissionsFromUser( context: Context, @@ -278,7 +288,8 @@ declare namespace abilityAccessCtrl { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ requestPermissionsFromUser(context: Context, permissionList: Array): Promise; @@ -591,7 +602,8 @@ declare namespace abilityAccessCtrl { * @syscap SystemCapability.Security.AccessToken * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ requestPermissionOnSetting(context: Context, permissionList: Array): Promise>; @@ -618,7 +630,6 @@ declare namespace abilityAccessCtrl { * * @param { number } tokenID - Token ID of the application. * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 202 - Not System App. Interface caller is not a system app. * @throws { BusinessError } 12100002 - The specified tokenID does not exist. * @throws { BusinessError } 12100007 - The service is abnormal. @@ -633,14 +644,14 @@ declare namespace abilityAccessCtrl { /** * GrantStatus. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @since 8 */ /** * GrantStatus. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @crossplatform * @since 10 @@ -648,11 +659,12 @@ declare namespace abilityAccessCtrl { /** * GrantStatus. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum GrantStatus { /** @@ -674,7 +686,8 @@ declare namespace abilityAccessCtrl { * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PERMISSION_DENIED = -1, /** @@ -696,7 +709,8 @@ declare namespace abilityAccessCtrl { * @syscap SystemCapability.Security.AccessToken * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PERMISSION_GRANTED = 0 } @@ -704,10 +718,11 @@ declare namespace abilityAccessCtrl { /** * Enum for permission state change type. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PermissionStateChangeType { /** @@ -715,7 +730,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ PERMISSION_REVOKED_OPER = 0, /** @@ -723,7 +739,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ PERMISSION_GRANTED_OPER = 1 } @@ -731,10 +748,11 @@ declare namespace abilityAccessCtrl { /** * Enum for permission request toggle status. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PermissionRequestToggleStatus { /** @@ -742,7 +760,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CLOSED = 0, /** @@ -750,7 +769,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPEN = 1, } @@ -761,7 +781,8 @@ declare namespace abilityAccessCtrl { * @interface PermissionStateChangeInfo * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 * @name PermissionStateChangeInfo */ interface PermissionStateChangeInfo { @@ -771,19 +792,21 @@ declare namespace abilityAccessCtrl { * @type { PermissionStateChangeType } * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ change: PermissionStateChangeType; /** * Indicates the application whose permission state has been changed. * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - tokenID: number; + tokenID: int; /** * Indicates the permission whose state has been changed. @@ -791,7 +814,8 @@ declare namespace abilityAccessCtrl { * @type { Permissions } * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ permissionName: Permissions; } @@ -799,10 +823,11 @@ declare namespace abilityAccessCtrl { /** * PermissionStatus. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PermissionStatus { /** @@ -810,7 +835,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DENIED = -1, /** @@ -818,7 +844,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GRANTED = 0, /** @@ -826,7 +853,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOT_DETERMINED = 1, /** @@ -834,7 +862,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INVALID = 2, /** @@ -842,7 +871,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RESTRICTED = 3 } @@ -850,10 +880,11 @@ declare namespace abilityAccessCtrl { /** * SwitchType. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum SwitchType { /** @@ -861,7 +892,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA = 0, /** @@ -869,7 +901,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MICROPHONE = 1, /** @@ -877,7 +910,8 @@ declare namespace abilityAccessCtrl { * * @syscap SystemCapability.Security.AccessToken * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LOCATION = 2, } @@ -902,7 +936,8 @@ export { Permissions }; * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type PermissionRequestResult = _PermissionRequestResult; /** @@ -922,6 +957,7 @@ export type PermissionRequestResult = _PermissionRequestResult; * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type Context = _Context; diff --git a/api/@ohos.accessibility.GesturePoint.d.ts b/api/@ohos.accessibility.GesturePoint.d.ts index c6d9afb51dcf7c3b45516a428989955991f59e53..500b61d3638b2d0e12ef6c1f2d1386b258a23632 100644 --- a/api/@ohos.accessibility.GesturePoint.d.ts +++ b/api/@ohos.accessibility.GesturePoint.d.ts @@ -25,6 +25,7 @@ * @since 9 */ export declare class GesturePoint { + /*** if arkts 1.1 */ /** * A constructor used to create a GesturePoint object. * @@ -35,6 +36,7 @@ export declare class GesturePoint { * @deprecated since 12 */ constructor(positionX: number, positionY: number); + /*** endif */ /** * Indicates the X coordinate of point. * diff --git a/api/@ohos.accessibility.config.d.ets b/api/@ohos.accessibility.config.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..bd0ec9a64c2447e0e70503f33913aaed68aa6b57 --- /dev/null +++ b/api/@ohos.accessibility.config.d.ets @@ -0,0 +1,112 @@ +/* + * Copyright (C) 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 AccessibilityKit + */ + +import { AccessibilityError } from './@ohos.accessibility'; + +/** + * Configuration of the accessibility. + * + * @namespace config + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ +declare namespace config { + /** + * Indicates the configuration of high-contrast text. + * + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ + const highContrastText: HighContrastTextConfig; + /** + * Indicates setting and getting in configuration. + * + * @typedef HighContrastTextConfig + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ + class HighContrastTextConfig { + /** + * Setting configuration value. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { boolean } value Indicates the value. + * @returns { Promise } + * @throws { BusinessError } 201 - Permission verification failed. + * The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ + set(value: boolean): Promise; + + /** + * Setting configuration value. + * + * @permission ohos.permission.WRITE_ACCESSIBILITY_CONFIG + * @param { boolean } value Indicates the value. + * @param { AsyncCallback } callback + * @throws { BusinessError } 201 - Permission verification failed. + * The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ + set(value: boolean, callback: (err: AccessibilityError) => void): void; + + /** + * Getting configuration value. + * + * @returns { Promise } + * @throws { BusinessError } 201 - Permission verification failed. + * The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ + get(): Promise; + + /** + * Getting configuration value. + * + * @param { AsyncCallback } callback + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @systemapi + * @since 20 + */ + get(callback:(err: AccessibilityError, data: boolean) => void): void; + } +} +export default config; diff --git a/api/@ohos.accessibility.d.ets b/api/@ohos.accessibility.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..f737eaa5bb2dd3af9815fff72854acf81e1ecc4f --- /dev/null +++ b/api/@ohos.accessibility.d.ets @@ -0,0 +1,389 @@ +/* + * Copyright (C) 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 AccessibilityKit + */ + +import { Callback } from './@ohos.base'; + +/** + * Defines the error interface. + * + * @extends Error + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + */ +export declare class AccessibilityError extends Error { + constructor(code: int, message: string); + code: int; +} + +/** + * Defines the basic callback. + * + * @typedef { AccessibilityCallback } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + */ +type AccessibilityCallback = (err: AccessibilityError, data?: T) => void; + +/** + * Accessibility + * + * @namespace accessibility + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ +/** + * Accessibility + * + * @namespace accessibility + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @atomicservice + * @since 11 + */ +declare namespace accessibility { + /** + * The action that the ability can execute. + * value range: { 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' | + * 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' | + * 'scrollForward' | 'scrollBackward' | 'setSelection' } + * + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + /** + * The action that the ability can execute. + * value range: { 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' | + * 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' | + * 'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' | + * 'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common' } + * + * @typedef {'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' | 'click' | + * 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' | 'scrollForward' | 'scrollBackward' | + * 'setSelection' | 'setCursorPosition' | 'home' | 'back' | 'recentTask' | 'notificationCenter' | + * 'controlCenter' | 'common'} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 12 + */ + type Action = 'accessibilityFocus' | 'clearAccessibilityFocus' | 'focus' | 'clearFocus' | 'clearSelection' | + 'click' | 'longClick' | 'cut' | 'copy' | 'paste' | 'select' | 'setText' | 'delete' | + 'scrollForward' | 'scrollBackward' | 'setSelection' | 'setCursorPosition' | 'home' | + 'back' | 'recentTask' | 'notificationCenter' | 'controlCenter' | 'common'; + + /** + * The type of the accessibility event. + * windowsChange/windowContentChange/windowStateChange/announcement/notificationChange/textTraversedAtMove + * value range: { 'accessibilityFocus' | 'accessibilityFocusClear' | + * 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' | + * 'textUpdate' | 'textSelectionUpdate' | 'scroll' } + * + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + /** + * The type of the accessibility event. + * windowsChange/windowContentChange/windowStateChange/announcement/notificationChange/textTraversedAtMove + * value range: { 'accessibilityFocus' | 'accessibilityFocusClear' | + * 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' | + * 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' | + * 'announceForAccessibility' } + * + * @typedef {'accessibilityFocus' | 'accessibilityFocusClear' | 'click' | 'longClick' | 'focus' | 'select' | + * 'hoverEnter' | 'hoverExit' | 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' | + * 'announceForAccessibility'} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 12 + */ + type EventType = 'accessibilityFocus' | 'accessibilityFocusClear' | + 'click' | 'longClick' | 'focus' | 'select' | 'hoverEnter' | 'hoverExit' | + 'textUpdate' | 'textSelectionUpdate' | 'scroll' | 'requestFocusForAccessibility' | + 'announceForAccessibility'; + + /** + * The change type of the windowsChange event. + * It's used when received the {@code windowsChange} event. + * + * @typedef {'add' | 'remove' | 'bounds' | 'active' | 'focus'} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + type WindowUpdateType = 'add' | 'remove' | 'bounds' | 'active' | 'focus'; + + /** + * The type of the observer. + * + * @typedef {'accessibilityStateChange' | 'touchGuideStateChange' | 'screenReaderStateChange'} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + type ObserverEventType = 'accessibilityStateChange' | 'touchGuideStateChange' | 'screenReaderStateChange'; + + /** + * The granularity of text move. + * + * @typedef {'char' | 'word' | 'line' | 'page' | 'paragraph'} + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + */ + type TextMoveUnit = 'char' | 'word' | 'line' | 'page' | 'paragraph'; + + /** + * Checks whether accessibility ability is enabled. + * + * @returns { boolean } Returns true if the accessibility is enabled; returns false otherwise. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 10 + */ + /** + * Checks whether accessibility ability is enabled. + * + * @returns { boolean } Returns true if the accessibility is enabled; returns false otherwise. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @atomicservice + * @since 11 + */ + function isOpenAccessibilitySync(): boolean; + + /** + * Checks touch browser ability (which is used by talkback) is enabled. + * + * @returns { boolean } Returns true if the touch browser is enabled; returns false otherwise. + * @syscap SystemCapability.BarrierFree.Accessibility.Vision + * @since 10 + */ + /** + * Checks touch browser ability (which is used by talkback) is enabled. + * + * @returns { boolean } Returns true if the touch browser is enabled; returns false otherwise. + * @syscap SystemCapability.BarrierFree.Accessibility.Vision + * @atomicservice + * @since 11 + */ + function isOpenTouchGuideSync(): boolean; + + /** + * Send accessibility event. + * + * @param { EventInfo } event The object of the accessibility {@code EventInfo} . + * @param { AccessibilityCallback } callback Asynchronous callback interface. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ + function sendAccessibilityEvent(event: EventInfo, callback: AccessibilityCallback): void; + + /** + * Send accessibility event. + * + * @param { EventInfo } event The object of the accessibility {@code EventInfo} . + * @returns { Promise } Returns {@code true} if success ; returns {@code false} otherwise. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ + function sendAccessibilityEvent(event: EventInfo): Promise; + + /** + * Register the observe. + * + * @param { ObserverEventType } type state event type. + * @param { Callback } callback Asynchronous callback interface. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + function on(type: ObserverEventType, callback: Callback): void; + + /** + * Unregister the observe. + * + * @param { ObserverEventType } type state event type + * @param { Callback } callback Asynchronous callback interface. + * @throws { BusinessError } 401 - Input parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + function off(type: ObserverEventType, callback?: Callback): void; + + /** + * Indicates the info of events. + * + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + class EventInfo { + /** + * A constructor used to create a EventInfo object. + * + * @param { EventType } type - The type of the accessibility event. + * @param { string } bundleName - The name of the bundle. + * @param { Action } triggerAction - The action that the ability can execute. + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 11 + */ + constructor(type: EventType, bundleName: string, triggerAction: Action); + /** + * The type of an accessibility event. + * @type { EventType } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public type: EventType; + + /** + * The type of the window change event. + * @type { ?WindowUpdateType } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public windowUpdateType?: WindowUpdateType; + + /** + * The bundle name of the target application. + * @type { string } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public bundleName: string; + + /** + * The type of the event source component,such as button, chart. + * @type { ?string } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public componentType?: string; + + /** + * The page id of the event source. + * @type { ?number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public pageId?: number; + + /** + * The accessibility event description. + * @type { ?string } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public description?: string; + + /** + * The action that triggers the accessibility event, for example, clicking or focusing a view. + * @type { Action } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public triggerAction: Action; + + /** + * The movement step used for reading texts. + * @type { ?TextMoveUnit } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public textMoveUnit?: TextMoveUnit; + + /** + * The content list. + * @type { ?Array } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public contents?: Array; + + /** + * The content changed before. + * @type { ?string } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public lastContent?: string; + + /** + * The start index of listed items on the screen. + * @type { ?number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public beginIndex?: number; + + /** + * The index of the current item on the screen. + * @type { ?number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public currentIndex?: number; + + /** + * The end index of listed items on the screen. + * @type { ?number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public endIndex?: number; + + /** + * The total of the items, talkback used it when scroll. + * @type { ?number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 7 + */ + public itemCount?: number; + + /** + * The id of element. + * @type { ?number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 12 + */ + public elementId?: number; + + /** + * The content of announce accessibility text. + * @type { ?string } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 12 + */ + public textAnnouncedForAccessibility?: string; + + /** + * The customized element id. + * @type { ?string } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 12 + */ + public customId?: string; + } +} +export default accessibility; \ No newline at end of file diff --git a/api/@ohos.account.appAccount.d.ts b/api/@ohos.account.appAccount.d.ts index d814c3546f1dac2d7251f74f572a4eebfa5d610f..95092b2b9f1e6426bc6e6c7f756fbcfd64e5354c 100644 --- a/api/@ohos.account.appAccount.d.ts +++ b/api/@ohos.account.appAccount.d.ts @@ -21,13 +21,18 @@ import type { AsyncCallback, Callback } from './@ohos.base'; import type Want from './@ohos.app.ability.Want'; import type rpc from './@ohos.rpc'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ + /** * This module provides the capability to manage application accounts. * * @namespace appAccount * @syscap SystemCapability.Account.AppAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace appAccount { /** @@ -35,7 +40,8 @@ declare namespace appAccount { * * @returns { AppAccountManager } Returns the instance of the AppAccountManager. * @syscap SystemCapability.Account.AppAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ function createAppAccountManager(): AppAccountManager; @@ -44,7 +50,8 @@ declare namespace appAccount { * * @interface AppAccountManager * @syscap SystemCapability.Account.AppAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AppAccountManager { /** @@ -107,7 +114,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300004 - Account already exists. * @throws { BusinessError } 12300007 - The number of accounts reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ createAccount(name: string, callback: AsyncCallback): void; @@ -127,7 +135,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300004 - Account already exists. * @throws { BusinessError } 12300007 - The number of accounts reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ createAccount(name: string, options: CreateAccountOptions, callback: AsyncCallback): void; @@ -147,7 +156,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300004 - Account already exists. * @throws { BusinessError } 12300007 - The number of accounts reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ createAccount(name: string, options?: CreateAccountOptions): Promise; @@ -184,7 +194,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ createAccountImplicitly(owner: string, callback: AuthCallback): void; @@ -203,7 +214,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ createAccountImplicitly(owner: string, options: CreateAccountImplicitlyOptions, callback: AuthCallback): void; @@ -248,7 +260,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ removeAccount(name: string, callback: AsyncCallback): void; @@ -265,7 +278,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ removeAccount(name: string): Promise; @@ -342,7 +356,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400001 - Application not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Sets a third-party application with the specified bundle name to access the given application @@ -359,7 +374,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400005 - The size of authorization list reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ setAppAccess(name: string, bundleName: string, isAccessible: boolean, callback: AsyncCallback): void; @@ -378,7 +394,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400001 - Application not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Sets a third-party application with the specified bundle name to access the given application @@ -395,7 +412,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400005 - The size of authorization list reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ setAppAccess(name: string, bundleName: string, isAccessible: boolean): Promise; @@ -412,7 +430,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name or bundleName. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAppAccess(name: string, bundleName: string, callback: AsyncCallback): void; @@ -429,7 +448,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name or bundleName. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAppAccess(name: string, bundleName: string): Promise; @@ -487,7 +507,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkDataSyncEnabled(name: string, callback: AsyncCallback): void; @@ -509,7 +530,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkDataSyncEnabled(name: string): Promise; @@ -554,7 +576,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name, credentialType or credential. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setCredential(name: string, credentialType: string, credential: string, callback: AsyncCallback): void; @@ -571,7 +594,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name, credentialType or credential. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setCredential(name: string, credentialType: string, credential: string): Promise; @@ -688,7 +712,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setDataSyncEnabled(name: string, isEnabled: boolean, callback: AsyncCallback): void; @@ -719,7 +744,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setDataSyncEnabled(name: string, isEnabled: boolean): Promise; @@ -765,7 +791,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400003 - The number of custom data reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setCustomData(name: string, key: string, value: string, callback: AsyncCallback): void; @@ -783,7 +810,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400003 - The number of custom data reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setCustomData(name: string, key: string, value: string): Promise; @@ -832,7 +860,8 @@ declare namespace appAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllAccounts(callback: AsyncCallback>): void; @@ -847,7 +876,8 @@ declare namespace appAccount { * @returns { Promise> } Returns a list of application accounts. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllAccounts(): Promise>; @@ -901,7 +931,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid owner. * @throws { BusinessError } 12400001 - Application not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Gets information about all accounts of a specified account owner. @@ -918,7 +949,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid owner. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getAccountsByOwner(owner: string, callback: AsyncCallback>): void; @@ -938,7 +970,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid owner. * @throws { BusinessError } 12400001 - Application not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Gets information about all accounts of a specified account owner. @@ -955,7 +988,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid owner. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getAccountsByOwner(owner: string): Promise>; @@ -998,7 +1032,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300102 - Credential not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getCredential(name: string, credentialType: string, callback: AsyncCallback): void; @@ -1015,7 +1050,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300102 - Credential not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getCredential(name: string, credentialType: string): Promise; @@ -1085,7 +1121,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400002 - Custom data not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getCustomData(name: string, key: string, callback: AsyncCallback): void; @@ -1102,7 +1139,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400002 - Custom data not found * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getCustomData(name: string, key: string): Promise; @@ -1119,7 +1157,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400002 - Custom data not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getCustomDataSync(name: string, key: string): string; @@ -1156,7 +1195,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid type or owners. * @throws { BusinessError } 12400001 - Application not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Subscribes to the change events of accounts of the specified owners. @@ -1173,7 +1213,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid type or owners. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'accountChange', owners: Array, callback: Callback>): void; @@ -1199,7 +1240,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300001 - System service exception. * @throws { BusinessError } 12300002 - Invalid type. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'accountChange', callback?: Callback>): void; @@ -1240,7 +1282,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ auth(name: string, owner: string, authType: string, callback: AuthCallback): void; @@ -1261,7 +1304,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ auth( name: string, @@ -1313,7 +1357,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthToken(name: string, owner: string, authType: string, callback: AsyncCallback): void; @@ -1331,7 +1376,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthToken(name: string, owner: string, authType: string): Promise; @@ -1383,7 +1429,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400004 - The number of tokens reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setAuthToken(name: string, authType: string, token: string, callback: AsyncCallback): void; @@ -1403,7 +1450,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12400004 - The number of tokens reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setAuthToken(name: string, authType: string, token: string): Promise; @@ -1458,7 +1506,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteAuthToken(name: string, owner: string, authType: string, token: string, callback: AsyncCallback): void; @@ -1479,7 +1528,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteAuthToken(name: string, owner: string, authType: string, token: string): Promise; @@ -1542,7 +1592,8 @@ declare namespace appAccount { * @throws { BusinessError } 12400001 - Application not found. * @throws { BusinessError } 12400005 - The size of authorization list reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Sets the auth token visibility of the specified authentication type to a third-party application. @@ -1562,7 +1613,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300107 - AuthType not found. * @throws { BusinessError } 12400005 - The size of authorization list reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ setAuthTokenVisibility( name: string, @@ -1591,7 +1643,8 @@ declare namespace appAccount { * @throws { BusinessError } 12400001 - Application not found. * @throws { BusinessError } 12400005 - The size of authorization list reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Sets the auth token visibility of the specified authentication type to a third-party application. @@ -1611,7 +1664,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300107 - AuthType not found. * @throws { BusinessError } 12400005 - The size of authorization list reaches the upper limit. * @syscap SystemCapability.Account.AppAccount - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ setAuthTokenVisibility(name: string, authType: string, bundleName: string, isVisible: boolean): Promise; @@ -1668,7 +1722,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAuthTokenVisibility( name: string, @@ -1693,7 +1748,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAuthTokenVisibility(name: string, authType: string, bundleName: string): Promise; @@ -1736,7 +1792,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name or owner. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllAuthTokens(name: string, owner: string, callback: AsyncCallback>): void; @@ -1752,7 +1809,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid name or owner. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllAuthTokens(name: string, owner: string): Promise>; @@ -1803,7 +1861,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthList(name: string, authType: string, callback: AsyncCallback>): void; @@ -1822,7 +1881,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300107 - AuthType not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthList(name: string, authType: string): Promise>; @@ -1869,7 +1929,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid sessionId. * @throws { BusinessError } 12300108 - Session not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthCallback(sessionId: string, callback: AsyncCallback): void; @@ -1886,7 +1947,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid sessionId. * @throws { BusinessError } 12300108 - Session not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthCallback(sessionId: string): Promise; @@ -1927,7 +1989,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid owner. * @throws { BusinessError } 12300113 - Authenticator service not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ queryAuthenticatorInfo(owner: string, callback: AsyncCallback): void; @@ -1942,7 +2005,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300002 - Invalid owner. * @throws { BusinessError } 12300113 - Authenticator service not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ queryAuthenticatorInfo(owner: string): Promise; @@ -1962,7 +2026,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAccountLabels(name: string, owner: string, labels: Array, callback: AsyncCallback): void; @@ -1982,7 +2047,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAccountLabels(name: string, owner: string, labels: Array): Promise; @@ -1999,7 +2065,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300102 - Credential not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteCredential(name: string, credentialType: string, callback: AsyncCallback): void; @@ -2016,7 +2083,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300003 - Account not found. * @throws { BusinessError } 12300102 - Credential not found. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteCredential(name: string, credentialType: string): Promise; @@ -2032,7 +2100,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300010 - Account service busy. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ selectAccountsByOptions(options: SelectAccountsOptions, callback: AsyncCallback>): void; @@ -2048,7 +2117,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300010 - Account service busy. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ selectAccountsByOptions(options: SelectAccountsOptions): Promise>; @@ -2067,7 +2137,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ verifyCredential(name: string, owner: string, callback: AuthCallback): void; /** @@ -2086,7 +2157,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ verifyCredential(name: string, owner: string, options: VerifyCredentialOptions, callback: AuthCallback): void; @@ -2106,7 +2178,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setAuthenticatorProperties(owner: string, callback: AuthCallback): void; /** @@ -2126,7 +2199,8 @@ declare namespace appAccount { * @throws { BusinessError } 12300113 - Authenticator service not found. * @throws { BusinessError } 12300114 - Authenticator service exception. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setAuthenticatorProperties(owner: string, options: SetPropertiesOptions, callback: AuthCallback): void; } @@ -2136,7 +2210,8 @@ declare namespace appAccount { * * @interface AppAccountInfo * @syscap SystemCapability.Account.AppAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AppAccountInfo { /** @@ -2144,7 +2219,8 @@ declare namespace appAccount { * * @type { string } * @syscap SystemCapability.Account.AppAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ owner: string; @@ -2153,7 +2229,8 @@ declare namespace appAccount { * * @type { string } * @syscap SystemCapability.Account.AppAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; } @@ -2194,7 +2271,8 @@ declare namespace appAccount { * * @interface AuthTokenInfo * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthTokenInfo { /** @@ -2202,7 +2280,8 @@ declare namespace appAccount { * * @type { string } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ authType: string; @@ -2211,7 +2290,8 @@ declare namespace appAccount { * * @type { string } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ token: string; @@ -2220,7 +2300,8 @@ declare namespace appAccount { * * @type { ?AppAccountInfo } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ account?: AppAccountInfo; } @@ -2230,7 +2311,8 @@ declare namespace appAccount { * * @interface AuthenticatorInfo * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthenticatorInfo { /** @@ -2238,27 +2320,30 @@ declare namespace appAccount { * * @type { string } * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ owner: string; /** * The icon id of an authenticator. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - iconId: number; + iconId: int; /** * The label id of an authenticator. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - labelId: number; + labelId: int; } /** @@ -2266,7 +2351,8 @@ declare namespace appAccount { * * @interface AuthResult * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthResult { /** @@ -2274,7 +2360,8 @@ declare namespace appAccount { * * @type { ?AppAccountInfo } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ account?: AppAccountInfo; @@ -2283,7 +2370,8 @@ declare namespace appAccount { * * @type { ?AuthTokenInfo } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ tokenInfo?: AuthTokenInfo; } @@ -2293,7 +2381,8 @@ declare namespace appAccount { * * @interface CreateAccountOptions * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CreateAccountOptions { /** @@ -2302,7 +2391,8 @@ declare namespace appAccount { * * @type { ?Record } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ customData?: Record; } @@ -2312,7 +2402,8 @@ declare namespace appAccount { * * @interface CreateAccountImplicitlyOptions * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CreateAccountImplicitlyOptions { /** @@ -2320,7 +2411,8 @@ declare namespace appAccount { * * @type { ?Array } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ requiredLabels?: Array; @@ -2329,7 +2421,8 @@ declare namespace appAccount { * * @type { ?string } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ authType?: string; @@ -2341,7 +2434,8 @@ declare namespace appAccount { * * @type { ?Record } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Record; } @@ -2351,7 +2445,8 @@ declare namespace appAccount { * * @interface SelectAccountsOptions * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SelectAccountsOptions { /** @@ -2359,7 +2454,8 @@ declare namespace appAccount { * * @type { ?Array } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ allowedAccounts?: Array; @@ -2368,7 +2464,8 @@ declare namespace appAccount { * * @type { ?Array } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ allowedOwners?: Array; @@ -2377,7 +2474,8 @@ declare namespace appAccount { * * @type { ?Array } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ requiredLabels?: Array; } @@ -2387,7 +2485,8 @@ declare namespace appAccount { * * @interface VerifyCredentialOptions * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface VerifyCredentialOptions { /** @@ -2395,7 +2494,8 @@ declare namespace appAccount { * * @type { ?string } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ credentialType?: string; @@ -2404,7 +2504,8 @@ declare namespace appAccount { * * @type { ?string } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ credential?: string; @@ -2416,7 +2517,8 @@ declare namespace appAccount { * * @type { ?Record } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Record; } @@ -2426,7 +2528,8 @@ declare namespace appAccount { * * @interface SetPropertiesOptions * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SetPropertiesOptions { /** @@ -2434,7 +2537,8 @@ declare namespace appAccount { * * @type { ?Record } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ properties?: Record; @@ -2446,7 +2550,8 @@ declare namespace appAccount { * * @type { ?Record } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Record; } @@ -2456,7 +2561,8 @@ declare namespace appAccount { * * @enum { string } Constants * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum Constants { /** @@ -2483,7 +2589,8 @@ declare namespace appAccount { * Indicates the action for creating account implicitly. * * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_CREATE_ACCOUNT_IMPLICITLY = 'createAccountImplicitly', @@ -2491,7 +2598,8 @@ declare namespace appAccount { * Indicates the action for authenticating. * * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_AUTH = 'auth', @@ -2499,7 +2607,8 @@ declare namespace appAccount { * Indicates the action for verifying credential. * * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_VERIFY_CREDENTIAL = 'verifyCredential', @@ -2507,7 +2616,8 @@ declare namespace appAccount { * Indicates the action for set authenticator properties. * * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_SET_AUTHENTICATOR_PROPERTIES = 'setAuthenticatorProperties', @@ -2515,7 +2625,8 @@ declare namespace appAccount { * Indicates the key of name. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_NAME = 'name', @@ -2523,7 +2634,8 @@ declare namespace appAccount { * Indicates the key of owner. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_OWNER = 'owner', @@ -2531,7 +2643,8 @@ declare namespace appAccount { * Indicates the key of token. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_TOKEN = 'token', @@ -2539,7 +2652,8 @@ declare namespace appAccount { * Indicates the key of action. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_ACTION = 'action', @@ -2547,7 +2661,8 @@ declare namespace appAccount { * Indicates the key of authentication type. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_AUTH_TYPE = 'authType', @@ -2555,7 +2670,8 @@ declare namespace appAccount { * Indicates the key of session id. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_SESSION_ID = 'sessionId', @@ -2563,7 +2679,8 @@ declare namespace appAccount { * Indicates the key of caller pid. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_CALLER_PID = 'callerPid', @@ -2571,7 +2688,8 @@ declare namespace appAccount { * Indicates the key of caller uid. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_CALLER_UID = 'callerUid', @@ -2579,7 +2697,8 @@ declare namespace appAccount { * Indicates the key of caller bundle name. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_CALLER_BUNDLE_NAME = 'callerBundleName', @@ -2587,7 +2706,8 @@ declare namespace appAccount { * Indicates the key of required labels. * * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_REQUIRED_LABELS = 'requiredLabels', @@ -2595,7 +2715,8 @@ declare namespace appAccount { * Indicates the key of boolean result. * * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEY_BOOLEAN_RESULT = 'booleanResult' } @@ -2603,7 +2724,7 @@ declare namespace appAccount { /** * Provides result code definition. * - * @enum { number } ResultCode + * @enum { int } ResultCode * @syscap SystemCapability.Account.AppAccount * @since 8 * @deprecated since 9 @@ -2799,7 +2920,7 @@ declare namespace appAccount { * @since 8 * @deprecated since 9 */ - onResult: (code: number, result: { [key: string]: any }) => void; + onResult: (code: int, result: { [key: string]: any }) => void; /** * Notifies the client that the authentication request need to be redirected. @@ -2817,7 +2938,8 @@ declare namespace appAccount { * * @interface AuthCallback * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthCallback { /** @@ -2825,16 +2947,18 @@ declare namespace appAccount { * * @type { function } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - onResult: (code: number, result?: AuthResult) => void; + onResult: (code: int, result?: AuthResult) => void; /** * Notifies the client that the authentication request need to be redirected. * * @type { function } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onRequestRedirected: (request: Want) => void; @@ -2843,7 +2967,8 @@ declare namespace appAccount { * * @type { ?function } * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onRequestContinued?: () => void; } @@ -2852,7 +2977,8 @@ declare namespace appAccount { * Provides methods for authenticator. * * @syscap SystemCapability.Account.AppAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 * @name Authenticator */ class Authenticator { @@ -2881,7 +3007,8 @@ declare namespace appAccount { * @param { CreateAccountImplicitlyOptions } options - Indicates the authenticator-specific options for the request. * @param { AuthCallback } callback - Indicates the authenticator callback. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ createAccountImplicitly(options: CreateAccountImplicitlyOptions, callback: AuthCallback): void; @@ -2914,7 +3041,8 @@ declare namespace appAccount { * @param { Record } options - Indicates the authenticator-specific options for the request. * @param { AuthCallback } callback - Indicates the authenticator callback. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ auth(name: string, authType: string, options: Record, callback: AuthCallback): void; @@ -2928,7 +3056,8 @@ declare namespace appAccount { * @param { VerifyCredentialOptions } options - Indicates the options for verifying credential. * @param { AuthCallback } callback - Indicates the authenticator callback. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthCallback): void; @@ -2938,7 +3067,8 @@ declare namespace appAccount { * @param { SetPropertiesOptions } options - Indicates the options for setting properties. * @param { AuthCallback } callback - Indicates the authenticator callback. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setProperties(options: SetPropertiesOptions, callback: AuthCallback): void; @@ -2949,7 +3079,8 @@ declare namespace appAccount { * @param { Array } labels - Indicates an array of labels to check. * @param { AuthCallback } callback - Indicates the authenticator callback. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAccountLabels(name: string, labels: Array, callback: AuthCallback): void; @@ -2959,7 +3090,8 @@ declare namespace appAccount { * @param { string } name - Indicates the account name. * @param { AuthCallback } callback - Indicates the authenticator callback. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkAccountRemovable(name: string, callback: AuthCallback): void; @@ -2968,7 +3100,8 @@ declare namespace appAccount { * * @returns { rpc.RemoteObject } Returns a remote object. * @syscap SystemCapability.Account.AppAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getRemoteObject(): rpc.RemoteObject; } diff --git a/api/@ohos.account.distributedAccount.d.ts b/api/@ohos.account.distributedAccount.d.ts index 1ad094694a3eaba5f3bc54147584c02da4b06cff..a380a85cc2926f3fc1de52077176c0a4a4839cbf 100644 --- a/api/@ohos.account.distributedAccount.d.ts +++ b/api/@ohos.account.distributedAccount.d.ts @@ -19,13 +19,18 @@ */ import type { AsyncCallback } from './@ohos.base'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ + /** * This module provides the capability to manage distributed accounts. * * @namespace distributedAccount * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace distributedAccount { /** @@ -33,7 +38,8 @@ declare namespace distributedAccount { * * @returns { DistributedAccountAbility } Ability to manage operations of distributed account. * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDistributedAccountAbility(): DistributedAccountAbility; @@ -42,7 +48,8 @@ declare namespace distributedAccount { * * @interface DistributedAccountAbility * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DistributedAccountAbility { /** @@ -79,7 +86,8 @@ declare namespace distributedAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getOsAccountDistributedInfo(callback: AsyncCallback): void; @@ -91,7 +99,8 @@ declare namespace distributedAccount { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 12300001 - System service exception. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getOsAccountDistributedInfo(): Promise; @@ -99,7 +108,7 @@ declare namespace distributedAccount { * Gets the distributed information of the specified OS account. * * @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the specified OS account. + * @param { int } localId - Indicates the local ID of the specified OS account. * @param { AsyncCallback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -109,15 +118,16 @@ declare namespace distributedAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountDistributedInfoByLocalId(localId: number, callback: AsyncCallback): void; + getOsAccountDistributedInfoByLocalId(localId: int, callback: AsyncCallback): void; /** * Gets the distributed information of the specified OS account. * * @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the specified OS account. + * @param { int } localId - Indicates the local ID of the specified OS account. * @returns { Promise } The distributed information of the specified OS account. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -127,9 +137,10 @@ declare namespace distributedAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountDistributedInfoByLocalId(localId: number): Promise; + getOsAccountDistributedInfoByLocalId(localId: int): Promise; /** * Updates the distributed information of the OS account. @@ -171,7 +182,8 @@ declare namespace distributedAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setOsAccountDistributedInfo(accountInfo: DistributedInfo, callback: AsyncCallback): void; @@ -189,7 +201,8 @@ declare namespace distributedAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ setOsAccountDistributedInfo(accountInfo: DistributedInfo): Promise; @@ -197,7 +210,7 @@ declare namespace distributedAccount { * Sets the distributed information of the specified OS account. * * @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { DistributedInfo } distributedInfo - Indicates the distributed information. * @param { AsyncCallback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. @@ -210,10 +223,11 @@ declare namespace distributedAccount { * @throws { BusinessError } 12300008 - Restricted OS account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ setOsAccountDistributedInfoByLocalId( - localId: number, + localId: int, distributedInfo: DistributedInfo, callback: AsyncCallback ): void; @@ -222,7 +236,7 @@ declare namespace distributedAccount { * Sets the distributed information of the specified OS account. * * @permission ohos.permission.MANAGE_DISTRIBUTED_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { DistributedInfo } distributedInfo - Indicates the distributed information. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. @@ -235,24 +249,27 @@ declare namespace distributedAccount { * @throws { BusinessError } 12300008 - Restricted OS account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - setOsAccountDistributedInfoByLocalId(localId: number, distributedInfo: DistributedInfo): Promise; + setOsAccountDistributedInfoByLocalId(localId: int, distributedInfo: DistributedInfo): Promise; } /** * Enum for distributed account status. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Account.OsAccount - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum DistributedAccountStatus { /** * Indicates that the account is not logged in. * * @syscap SystemCapability.Account.OsAccount - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NOT_LOGGED_IN = 0, @@ -260,7 +277,8 @@ declare namespace distributedAccount { * Indicates that the account is logged in. * * @syscap SystemCapability.Account.OsAccount - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ LOGGED_IN = 1 } @@ -270,7 +288,8 @@ declare namespace distributedAccount { * * @interface DistributedInfo * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DistributedInfo { /** @@ -278,7 +297,8 @@ declare namespace distributedAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -287,7 +307,8 @@ declare namespace distributedAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ id: string; @@ -296,7 +317,8 @@ declare namespace distributedAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ event: string; @@ -305,7 +327,8 @@ declare namespace distributedAccount { * * @type { ?string } * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ nickname?: string; @@ -314,7 +337,8 @@ declare namespace distributedAccount { * * @type { ?string } * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ avatar?: string; @@ -324,7 +348,8 @@ declare namespace distributedAccount { * @type { ?DistributedAccountStatus } * @readonly * @syscap SystemCapability.Account.OsAccount - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly status?: DistributedAccountStatus; @@ -333,7 +358,8 @@ declare namespace distributedAccount { * * @type { ?object } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ scalableData?: object; } diff --git a/api/@ohos.account.osAccount.d.ts b/api/@ohos.account.osAccount.d.ts index 0b9cbc77692ea87218d737a7b13dbfbd824c64a3..681d4b8c04d4da11b97328be76953383b5b70aa2 100644 --- a/api/@ohos.account.osAccount.d.ts +++ b/api/@ohos.account.osAccount.d.ts @@ -20,13 +20,17 @@ import type distributedAccount from './@ohos.account.distributedAccount'; import type { AsyncCallback, Callback } from './@ohos.base'; +/*** if arkts 1.1 */ +import { int, long } from './@ohos.base'; +/*** endif */ /** * This module provides the capability to manage os accounts. * * @namespace osAccount * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace osAccount { /** @@ -34,7 +38,8 @@ declare namespace osAccount { * * @returns { AccountManager } Returns the instance of the AccountManager. * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAccountManager(): AccountManager; @@ -43,7 +48,8 @@ declare namespace osAccount { * * @interface AccountManager * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AccountManager { /** @@ -55,7 +61,7 @@ declare namespace osAccount { *

* * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -68,7 +74,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300009 - Account has been activated. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Activates a specified OS account. @@ -79,7 +86,7 @@ declare namespace osAccount { *

* * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -92,9 +99,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300016 - The number of logged in accounts reaches the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - activateOsAccount(localId: number, callback: AsyncCallback): void; + activateOsAccount(localId: int, callback: AsyncCallback): void; /** * Activates a specified OS account. @@ -105,7 +113,7 @@ declare namespace osAccount { *

* * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -118,7 +126,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300009 - Account has been activated. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Activates a specified OS account. @@ -129,7 +138,7 @@ declare namespace osAccount { *

* * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -142,15 +151,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300016 - The number of logged in accounts reaches the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - activateOsAccount(localId: number): Promise; + activateOsAccount(localId: int): Promise; /** * Deactivates a specified OS account. * * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -161,9 +171,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - deactivateOsAccount(localId: number): Promise; + deactivateOsAccount(localId: int): Promise; /** * Checks whether the function of supporting multiple OS accounts is enabled. @@ -195,7 +206,8 @@ declare namespace osAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkMultiOsAccountEnabled(callback: AsyncCallback): void; @@ -205,7 +217,8 @@ declare namespace osAccount { * @returns { Promise } Returns {@code true} if this function is enabled; returns {@code false} otherwise. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkMultiOsAccountEnabled(): Promise; @@ -213,33 +226,33 @@ declare namespace osAccount { * Checks whether an OS account is activated based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Indicates the callback for checking whether the OS account is activated. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#checkOsAccountActivated */ - isOsAccountActived(localId: number, callback: AsyncCallback): void; + isOsAccountActived(localId: int, callback: AsyncCallback): void; /** * Checks whether an OS account is activated based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns {@code true} if the OS account is activated; returns {@code false} otherwise. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#checkOsAccountActivated */ - isOsAccountActived(localId: number): Promise; + isOsAccountActived(localId: int): Promise; /** * Checks whether an OS account is activated based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Indicates the callback for checking whether the OS account is activated. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -251,13 +264,13 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - checkOsAccountActivated(localId: number, callback: AsyncCallback): void; + checkOsAccountActivated(localId: int, callback: AsyncCallback): void; /** * Checks whether an OS account is activated based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } - Returns {@code true} if the OS account is activated; returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -269,13 +282,13 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - checkOsAccountActivated(localId: number): Promise; + checkOsAccountActivated(localId: int): Promise; /** * Checks whether an OS account is activated based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } - Returns {@code true} if the OS account is activated; returns {@code false} otherwise. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -285,15 +298,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - isOsAccountActivated(localId: number): Promise; + isOsAccountActivated(localId: int): Promise; /** * Checks whether a constraint has been enabled for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to check. The value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -306,13 +320,13 @@ declare namespace osAccount { * @deprecated since 9 * @useinstead osAccount.AccountManager#checkOsAccountConstraintEnabled */ - isOsAccountConstraintEnable(localId: number, constraint: string, callback: AsyncCallback): void; + isOsAccountConstraintEnable(localId: int, constraint: string, callback: AsyncCallback): void; /** * Checks whether a constraint has been enabled for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to check. The value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -326,13 +340,13 @@ declare namespace osAccount { * @deprecated since 9 * @useinstead osAccount.AccountManager#checkOsAccountConstraintEnabled */ - isOsAccountConstraintEnable(localId: number, constraint: string): Promise; + isOsAccountConstraintEnable(localId: int, constraint: string): Promise; /** * Checks whether the given constraint is enabled for the specified OS account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to check. For example: the value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -350,13 +364,13 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - checkOsAccountConstraintEnabled(localId: number, constraint: string, callback: AsyncCallback): void; + checkOsAccountConstraintEnabled(localId: int, constraint: string, callback: AsyncCallback): void; /** * Checks whether the given constraint is enabled for the specified OS account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to check. For example: the value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -374,7 +388,7 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - checkOsAccountConstraintEnabled(localId: number, constraint: string): Promise; + checkOsAccountConstraintEnabled(localId: int, constraint: string): Promise; /** * Checks whether the given constraint is enabled for the current OS account. @@ -390,7 +404,8 @@ declare namespace osAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isOsAccountConstraintEnabled(constraint: string): Promise; @@ -398,7 +413,7 @@ declare namespace osAccount { * Checks whether the given constraint is enabled for the specified OS account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to check. For example: the value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -414,9 +429,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - isOsAccountConstraintEnabled(localId: number, constraint: string): Promise; + isOsAccountConstraintEnabled(localId: int, constraint: string): Promise; /** * Checks whether this OS account is a test OS account. @@ -448,7 +464,8 @@ declare namespace osAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkOsAccountTestable(callback: AsyncCallback): void; @@ -458,7 +475,8 @@ declare namespace osAccount { * @returns { Promise } Returns {@code true} if this account is testable; returns {@code false} otherwise. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ checkOsAccountTestable(): Promise; @@ -479,7 +497,7 @@ declare namespace osAccount { * Checks whether an OS account has been verified based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Returns {@code true} if the OS account has been verified successfully; * returns {@code false} otherwise. * @syscap SystemCapability.Account.OsAccount @@ -487,13 +505,13 @@ declare namespace osAccount { * @deprecated since 9 * @useinstead osAccount.AccountManager#checkOsAccountVerified */ - isOsAccountVerified(localId: number, callback: AsyncCallback): void; + isOsAccountVerified(localId: int, callback: AsyncCallback): void; /** * Checks whether an OS account has been verified based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns {@code true} if the OS account has been verified successfully; * returns {@code false} otherwise. * @syscap SystemCapability.Account.OsAccount @@ -501,7 +519,7 @@ declare namespace osAccount { * @deprecated since 9 * @useinstead osAccount.AccountManager#checkOsAccountVerified */ - isOsAccountVerified(localId?: number): Promise; + isOsAccountVerified(localId?: int): Promise; /** * Checks whether the current OS account is verified. @@ -531,7 +549,7 @@ declare namespace osAccount { * Checks whether the specified OS account is verified. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Indicates the callback for checking whether the specified OS account is verified. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -543,13 +561,13 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - checkOsAccountVerified(localId: number, callback: AsyncCallback): void; + checkOsAccountVerified(localId: int, callback: AsyncCallback): void; /** * Checks whether the specified OS account is verified. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns whether the specified OS account is verified. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -561,7 +579,7 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - checkOsAccountVerified(localId: number): Promise; + checkOsAccountVerified(localId: int): Promise; /** * Checks whether the current OS account is unlocked. @@ -569,7 +587,8 @@ declare namespace osAccount { * @returns { Promise } Returns whether the current OS account is unlocked. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isOsAccountUnlocked(): Promise; @@ -577,7 +596,7 @@ declare namespace osAccount { * Checks whether the specified OS account is unlocked. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns whether the specified OS account is unlocked. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -587,15 +606,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - isOsAccountUnlocked(localId: number): Promise; + isOsAccountUnlocked(localId: int): Promise; /** * Removes an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Indicates the callback for removing the specified OS account. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -608,15 +628,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300010 - Service busy. Possible causes: The target account is being operated. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - removeOsAccount(localId: number, callback: AsyncCallback): void; + removeOsAccount(localId: int, callback: AsyncCallback): void; /** * Removes an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -629,15 +650,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300010 - Service busy. Possible causes: The target account is being operated. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - removeOsAccount(localId: number): Promise; + removeOsAccount(localId: int): Promise; /** * Sets constraints for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { Array } constraints - Indicates the constraints to set for the OS account. The value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -656,10 +678,11 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ setOsAccountConstraints( - localId: number, + localId: int, constraints: Array, enable: boolean, callback: AsyncCallback @@ -669,7 +692,7 @@ declare namespace osAccount { * Sets constraints for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { Array } constraints - Indicates the constraints to set for the OS account. The value can be: *
{@code constraint.wifi.set} - Indicates the constraint on configuring the Wi-Fi access point. *
{@code constraint.sms.use} - Indicates the constraint on sending and receiving short messages. @@ -688,15 +711,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - setOsAccountConstraints(localId: number, constraints: Array, enable: boolean): Promise; + setOsAccountConstraints(localId: int, constraints: Array, enable: boolean): Promise; /** * Sets the local name for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } localName - Indicates the local name to set for the OS account. * @param { AsyncCallback } callback - Indicates the callback for setting the specified OS account name. * @throws { BusinessError } 201 - Permission denied. @@ -709,15 +733,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - setOsAccountName(localId: number, localName: string, callback: AsyncCallback): void; + setOsAccountName(localId: int, localName: string, callback: AsyncCallback): void; /** * Sets the local name for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } localName - Indicates the local name to set for the OS account. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. @@ -730,9 +755,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - setOsAccountName(localId: number, localName: string): Promise; + setOsAccountName(localId: int, localName: string): Promise; /** * Gets the name of the OS account to which the caller belongs. @@ -740,7 +766,8 @@ declare namespace osAccount { * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getOsAccountName(): Promise; @@ -748,195 +775,202 @@ declare namespace osAccount { * Obtains the number of all OS accounts created on a device. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { AsyncCallback } callback - Returns the number of created OS accounts. + * @param { AsyncCallback } callback - Returns the number of created OS accounts. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountCount */ - getCreatedOsAccountsCount(callback: AsyncCallback): void; + getCreatedOsAccountsCount(callback: AsyncCallback): void; /** * Obtains the number of all OS accounts created on a device. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @returns { Promise } Returns the number of created OS accounts. + * @returns { Promise } Returns the number of created OS accounts. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountCount */ - getCreatedOsAccountsCount(): Promise; + getCreatedOsAccountsCount(): Promise; /** * Obtains the number of all OS accounts created on a device. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { AsyncCallback } callback - Returns the number of created OS accounts. + * @param { AsyncCallback } callback - Returns the number of created OS accounts. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountCount(callback: AsyncCallback): void; + getOsAccountCount(callback: AsyncCallback): void; /** * Obtains the number of all OS accounts created on a device. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @returns { Promise } Returns the number of created OS accounts. + * @returns { Promise } Returns the number of created OS accounts. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountCount(): Promise; + getOsAccountCount(): Promise; /** * Obtains the local ID of an OS account from the current process UID. * - * @param { AsyncCallback } callback - Returns the local ID of the OS account. + * @param { AsyncCallback } callback - Returns the local ID of the OS account. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalId */ - getOsAccountLocalIdFromProcess(callback: AsyncCallback): void; + getOsAccountLocalIdFromProcess(callback: AsyncCallback): void; /** * Obtains the local ID of an OS account from the current process UID. * - * @returns { Promise } Returns the local ID of the OS account. + * @returns { Promise } Returns the local ID of the OS account. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalId */ - getOsAccountLocalIdFromProcess(): Promise; + getOsAccountLocalIdFromProcess(): Promise; /** * Gets the local ID of the current OS account. * - * @param { AsyncCallback } callback - Indicates the callback for getting the local ID of the current OS account. + * @param { AsyncCallback } callback - Indicates the callback for getting the local ID of the current OS account. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalId(callback: AsyncCallback): void; + getOsAccountLocalId(callback: AsyncCallback): void; /** * Get the local ID of the current OS account. * - * @returns { Promise } Returns the local ID of the current account. + * @returns { Promise } Returns the local ID of the current account. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalId(): Promise; + getOsAccountLocalId(): Promise; /** * Gets the local ID of an OS account from the process UID * - * @param { number } uid - Indicates the process UID. - * @param { AsyncCallback } callback - Returns the local ID of the OS account. + * @param { int } uid - Indicates the process UID. + * @param { AsyncCallback } callback - Returns the local ID of the OS account. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalIdForUid */ - getOsAccountLocalIdFromUid(uid: number, callback: AsyncCallback): void; + getOsAccountLocalIdFromUid(uid: int, callback: AsyncCallback): void; /** * Gets the local ID of an OS account from the process UID * - * @param { number } uid - Indicates the process UID. - * @returns { Promise } Returns the local ID of the OS account. + * @param { int } uid - Indicates the process UID. + * @returns { Promise } Returns the local ID of the OS account. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalIdForUid */ - getOsAccountLocalIdFromUid(uid: number): Promise; + getOsAccountLocalIdFromUid(uid: int): Promise; /** * Gets the local ID of the OS account associated with the specified UID. * - * @param { number } uid - Indicates the process UID. - * @param { AsyncCallback } callback - Indicates the callback for getting the local ID of the OS account associated with the specified UID. + * @param { int } uid - Indicates the process UID. + * @param { AsyncCallback } callback - Indicates the callback for getting the local ID of the OS account associated with the specified UID. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid uid. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForUid(uid: number, callback: AsyncCallback): void; + getOsAccountLocalIdForUid(uid: int, callback: AsyncCallback): void; /** * Get the local ID of the OS account associated with the specified UID. * - * @param { number } uid - Indicates the process UID. - * @returns { Promise } - Returns the local ID of the OS account associated with the specified UID. + * @param { int } uid - Indicates the process UID. + * @returns { Promise } - Returns the local ID of the OS account associated with the specified UID. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid uid. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForUid(uid: number): Promise; + getOsAccountLocalIdForUid(uid: int): Promise; /** * Gets the local ID of the OS account associated with the specified UID synchronously. * - * @param { number } uid - Indicates the process UID. - * @returns { number } Returns the local ID of the OS account associated with the specified UID. + * @param { int } uid - Indicates the process UID. + * @returns { int } Returns the local ID of the OS account associated with the specified UID. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300002 - Invalid uid. * @syscap SystemCapability.Account.OsAccount - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForUidSync(uid: number): number; + getOsAccountLocalIdForUidSync(uid: int): int; /** * Queries the local ID of an OS account which is bound to the specified domain account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS * @param { DomainAccountInfo } domainInfo - Indicates the domain account info. - * @param { AsyncCallback } callback - Returns the local ID of the OS account. + * @param { AsyncCallback } callback - Returns the local ID of the OS account. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalIdForDomain */ - getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback): void; + getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback): void; /** * Queries the local ID of an OS account which is bound to the specified domain account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS * @param { DomainAccountInfo } domainInfo - Indicates the domain account info. - * @returns { Promise } Returns the local ID of the OS account. + * @returns { Promise } Returns the local ID of the OS account. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalIdForDomain */ - getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise; + getOsAccountLocalIdFromDomain(domainInfo: DomainAccountInfo): Promise; /** * Gets the local ID of the OS account associated with the specified domain account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS * @param { DomainAccountInfo } domainInfo - Indicates the domain account info. - * @param { AsyncCallback } callback - Indicates the callback for + * @param { AsyncCallback } callback - Indicates the callback for * getting the local ID of the OS account associated with the specified domain account. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -945,16 +979,17 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid domainInfo. * @syscap SystemCapability.Account.OsAccount * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback): void; + getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo, callback: AsyncCallback): void; /** * Gets the local ID of the OS account associated with the specified domain account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS * @param { DomainAccountInfo } domainInfo - Indicates the domain account info. - * @returns { Promise } Returns the local ID of the OS account associated with the specified domain account. + * @returns { Promise } Returns the local ID of the OS account associated with the specified domain account. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. @@ -962,79 +997,83 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid domainInfo. * @syscap SystemCapability.Account.OsAccount * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo): Promise; + getOsAccountLocalIdForDomain(domainInfo: DomainAccountInfo): Promise; /** * Queries the maximum number of OS accounts that can be created on a device. * - * @param { AsyncCallback } callback - Returns the maximum number of OS accounts that can be created. + * @param { AsyncCallback } callback - Returns the maximum number of OS accounts that can be created. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - queryMaxOsAccountNumber(callback: AsyncCallback): void; + queryMaxOsAccountNumber(callback: AsyncCallback): void; /** * Queries the maximum number of OS accounts that can be created on a device. * - * @returns { Promise } Returns the maximum number of OS accounts that can be created. + * @returns { Promise } Returns the maximum number of OS accounts that can be created. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - queryMaxOsAccountNumber(): Promise; + queryMaxOsAccountNumber(): Promise; /** * Queries the maximum number of OS accounts that can be logged in. * - * @returns { Promise } Returns the maximum number of OS accounts that can be logged in. + * @returns { Promise } Returns the maximum number of OS accounts that can be logged in. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - queryMaxLoggedInOsAccountNumber(): Promise; + queryMaxLoggedInOsAccountNumber(): Promise; /** * Obtains all constraints of an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback> } callback - Returns a list of constraints. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountConstraints */ - getOsAccountAllConstraints(localId: number, callback: AsyncCallback>): void; + getOsAccountAllConstraints(localId: int, callback: AsyncCallback>): void; /** * Obtains all constraints of an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise> } Returns a list of constraints. * @syscap SystemCapability.Account.OsAccount * @since 7 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountConstraints */ - getOsAccountAllConstraints(localId: number): Promise>; + getOsAccountAllConstraints(localId: int): Promise>; /** * Obtains all constraints of an account based on its ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback> } callback - Returns a list of constraints. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -1046,13 +1085,13 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - getOsAccountConstraints(localId: number, callback: AsyncCallback>): void; + getOsAccountConstraints(localId: int, callback: AsyncCallback>): void; /** * Obtains all constraints of an account based on its ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise> } Returns a list of constraints. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -1064,13 +1103,13 @@ declare namespace osAccount { * @since 9 * @deprecated since 11 */ - getOsAccountConstraints(localId: number): Promise>; + getOsAccountConstraints(localId: int): Promise>; /** * Gets all enabled constraints of the specified OS account by its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise> } Returns a list of constraints. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -1080,9 +1119,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - getEnabledOsAccountConstraints(localId: number): Promise>; + getEnabledOsAccountConstraints(localId: int): Promise>; /** * Queries the list of all the OS accounts that have been created in the system. @@ -1096,7 +1136,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ queryAllCreatedOsAccounts(callback: AsyncCallback>): void; @@ -1110,63 +1151,67 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ queryAllCreatedOsAccounts(): Promise>; /** * Queries the id list of all activated OS accounts. * - * @param { AsyncCallback> } callback - Returns a id list of OS accounts. + * @param { AsyncCallback> } callback - Returns a id list of OS accounts. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getActivatedOsAccountLocalIds */ - queryActivatedOsAccountIds(callback: AsyncCallback>): void; + queryActivatedOsAccountIds(callback: AsyncCallback>): void; /** * Queries the id list of all activated OS accounts. * - * @returns { Promise> } Returns a id list of OS accounts. + * @returns { Promise> } Returns a id list of OS accounts. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getActivatedOsAccountLocalIds */ - queryActivatedOsAccountIds(): Promise>; + queryActivatedOsAccountIds(): Promise>; /** * Gets the local IDs of all activated OS accounts. * - * @param { AsyncCallback> } callback - Indicates the callback for getting the local IDs of all activated OS accounts. + * @param { AsyncCallback> } callback - Indicates the callback for getting the local IDs of all activated OS accounts. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getActivatedOsAccountLocalIds(callback: AsyncCallback>): void; + getActivatedOsAccountLocalIds(callback: AsyncCallback>): void; /** * Gets the local IDs of all activated OS accounts. * - * @returns { Promise> } Returns all activated accounts. + * @returns { Promise> } Returns all activated accounts. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getActivatedOsAccountLocalIds(): Promise>; + getActivatedOsAccountLocalIds(): Promise>; /** * Gets the local ID of the foreground OS account. * - * @returns { Promise } Returns local ID of the foreground OS account. + * @returns { Promise } Returns local ID of the foreground OS account. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ - getForegroundOsAccountLocalId(): Promise; + getForegroundOsAccountLocalId(): Promise; /** * Creates an OS account using the local name and account type. @@ -1187,7 +1232,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300007 - The number of accounts has reached the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Creates an OS account with the specified local name and type. @@ -1209,7 +1255,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300007 - The number of accounts has reached the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ createOsAccount(localName: string, type: OsAccountType, callback: AsyncCallback): void; @@ -1232,7 +1279,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300007 - The number of accounts has reached the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Creates an OS account with the specified local name, type and options. @@ -1256,7 +1304,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300015 - The short name already exists. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ createOsAccount(localName: string, type: OsAccountType, options?: CreateOsAccountOptions): Promise; @@ -1280,7 +1329,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300007 - The number of accounts has reached the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Creates an OS account using the account type and domain account info. @@ -1303,7 +1353,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300007 - The number of accounts has reached the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ createOsAccountForDomain( type: OsAccountType, @@ -1331,7 +1382,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300007 - The number of accounts has reached the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Creates an OS account using the account type, domain account info and options. @@ -1356,7 +1408,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300015 - The short name already exists. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ createOsAccountForDomain(type: OsAccountType, domainInfo: DomainAccountInfo, options?: CreateOsAccountForDomainOptions): Promise; @@ -1446,7 +1499,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ queryOsAccount(): Promise; @@ -1454,7 +1508,7 @@ declare namespace osAccount { * Queries OS account information based on the local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Returns the OS account information; returns {@code null} if the query fails. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -1465,15 +1519,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - queryOsAccountById(localId: number, callback: AsyncCallback): void; + queryOsAccountById(localId: int, callback: AsyncCallback): void; /** * Queries OS account information based on the local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns the OS account information; returns {@code null} if the query fails. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -1484,15 +1539,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - queryOsAccountById(localId: number): Promise; + queryOsAccountById(localId: int): Promise; /** * Gets the domain account information associated with the specified OS account. * * @permission ohos.permission.GET_DOMAIN_ACCOUNTS and ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the specified OS account. + * @param { int } localId - Indicates the local ID of the specified OS account. * @returns { Promise } Returns the domain account information. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -1500,9 +1556,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300003 - OS account not found. * @syscap SystemCapability.Account.OsAccount - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountDomainInfo(localId: number): Promise; + getOsAccountDomainInfo(localId: int): Promise; /** * Obtains the type of this OS account from the current process. @@ -1537,7 +1594,8 @@ declare namespace osAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getOsAccountType(callback: AsyncCallback): void; @@ -1548,7 +1606,8 @@ declare namespace osAccount { * {@link OsAccountType#NORMAL}, and {@link OsAccountType#GUEST}. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getOsAccountType(): Promise; @@ -1556,7 +1615,7 @@ declare namespace osAccount { * Gets the type of the specified OS account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns the OS account type. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -1566,9 +1625,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountType(localId: number): Promise; + getOsAccountType(localId: int): Promise; /** * Obtains the distributed virtual device ID (DVID). @@ -1622,7 +1682,8 @@ declare namespace osAccount { *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ queryDistributedVirtualDeviceId(callback: AsyncCallback): void; @@ -1640,7 +1701,8 @@ declare namespace osAccount { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ queryDistributedVirtualDeviceId(): Promise; @@ -1648,7 +1710,7 @@ declare namespace osAccount { * Obtains the profile photo of an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Returns the profile photo if obtained; * returns {@code null} if the profile photo fails to be obtained. * @throws { BusinessError } 201 - Permission denied. @@ -1660,15 +1722,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountProfilePhoto(localId: number, callback: AsyncCallback): void; + getOsAccountProfilePhoto(localId: int, callback: AsyncCallback): void; /** * Obtains the profile photo of an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @returns { Promise } Returns the profile photo if obtained; * returns {@code null} if the profile photo fails to be obtained. * @throws { BusinessError } 201 - Permission denied. @@ -1680,15 +1743,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountProfilePhoto(localId: number): Promise; + getOsAccountProfilePhoto(localId: int): Promise; /** * Sets the profile photo for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } photo - Indicates the profile photo to set for the OS account. * @param { AsyncCallback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. @@ -1701,15 +1765,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - setOsAccountProfilePhoto(localId: number, photo: string, callback: AsyncCallback): void; + setOsAccountProfilePhoto(localId: int, photo: string, callback: AsyncCallback): void; /** * Sets the profile photo for an OS account based on its local ID. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } photo - Indicates the profile photo to set for the OS account. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. @@ -1722,117 +1787,122 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted Account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - setOsAccountProfilePhoto(localId: number, photo: string): Promise; + setOsAccountProfilePhoto(localId: int, photo: string): Promise; /** * Obtain localId according to serial number * - * @param { number } serialNumber - Indicates serial number. - * @param { AsyncCallback } callback - Returns localId. + * @param { long } serialNumber - Indicates serial number. + * @param { AsyncCallback } callback - Returns localId. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalIdForSerialNumber */ - getOsAccountLocalIdBySerialNumber(serialNumber: number, callback: AsyncCallback): void; + getOsAccountLocalIdBySerialNumber(serialNumber: long, callback: AsyncCallback): void; /** * Obtain localId according to serial number * - * @param { number } serialNumber - Indicates serial number. - * @returns { Promise } Returns localId. + * @param { long } serialNumber - Indicates serial number. + * @returns { Promise } Returns localId. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getOsAccountLocalIdForSerialNumber */ - getOsAccountLocalIdBySerialNumber(serialNumber: number): Promise; + getOsAccountLocalIdBySerialNumber(serialNumber: long): Promise; /** * Gets the local ID of the OS account associated with the serial number. * - * @param { number } serialNumber - Indicates serial number. - * @param { AsyncCallback } callback - Indicates the callback for getting the local ID of the OS account associated with the serial number. + * @param { long } serialNumber - Indicates serial number. + * @param { AsyncCallback } callback - Indicates the callback for getting the local ID of the OS account associated with the serial number. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid serialNumber. * @throws { BusinessError } 12300003 - The account indicated by serialNumber dose not exist. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForSerialNumber(serialNumber: number, callback: AsyncCallback): void; + getOsAccountLocalIdForSerialNumber(serialNumber: long, callback: AsyncCallback): void; /** * Gets the local ID of the OS account associated with the serial number. * - * @param { number } serialNumber - Indicates serial number. - * @returns { Promise } Returns the local ID of the OS account associated with the serial number. + * @param { long } serialNumber - Indicates serial number. + * @returns { Promise } Returns the local ID of the OS account associated with the serial number. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid serialNumber. * @throws { BusinessError } 12300003 - The account indicated by serialNumber dose not exist. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountLocalIdForSerialNumber(serialNumber: number): Promise; + getOsAccountLocalIdForSerialNumber(serialNumber: long): Promise; /** * Obtain serial number according to localId. * - * @param { number } localId - Indicates the local ID of the OS account. - * @param { AsyncCallback } callback - Returns serial number. + * @param { int } localId - Indicates the local ID of the OS account. + * @param { AsyncCallback } callback - Returns serial number. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getSerialNumberForOsAccountLocalId */ - getSerialNumberByOsAccountLocalId(localId: number, callback: AsyncCallback): void; + getSerialNumberByOsAccountLocalId(localId: int, callback: AsyncCallback): void; /** * Obtain serial number according to localId. * - * @param { number } localId - Indicates the local ID of the OS account. - * @returns { Promise } Returns serial number. + * @param { int } localId - Indicates the local ID of the OS account. + * @returns { Promise } Returns serial number. * @syscap SystemCapability.Account.OsAccount * @since 8 * @deprecated since 9 * @useinstead osAccount.AccountManager#getSerialNumberForOsAccountLocalId */ - getSerialNumberByOsAccountLocalId(localId: number): Promise; + getSerialNumberByOsAccountLocalId(localId: int): Promise; /** * Gets the serial number for the specified os account local id. * - * @param { number } localId - Indicates the local ID of the OS account. - * @param { AsyncCallback } callback - Indicates the callback for getting the serial number for the specified os account local id. + * @param { int } localId - Indicates the local ID of the OS account. + * @param { AsyncCallback } callback - Indicates the callback for getting the serial number for the specified os account local id. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid localId. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getSerialNumberForOsAccountLocalId(localId: number, callback: AsyncCallback): void; + getSerialNumberForOsAccountLocalId(localId: int, callback: AsyncCallback): void; /** * Gets the serial number for the specified os account local id. * - * @param { number } localId - Indicates the local ID of the OS account. - * @returns { Promise } Returns the serial number according to local ID. + * @param { int } localId - Indicates the local ID of the OS account. + * @returns { Promise } Returns the serial number according to local ID. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid localId. * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getSerialNumberForOsAccountLocalId(localId: number): Promise; + getSerialNumberForOsAccountLocalId(localId: int): Promise; /** * Subscribes to the change events of accounts. @@ -1843,7 +1913,7 @@ declare namespace osAccount { * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION * @param { 'activate' | 'activating' } type - Event type. * @param { string } name - Indicates the name of subscriber. - * @param { Callback } callback - Asynchronous callback interface. + * @param { Callback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -1852,9 +1922,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid type or name. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'activate' | 'activating', name: string, callback: Callback): void; + on(type: 'activate' | 'activating', name: string, callback: Callback): void; /** * Unsubscribes from account events. @@ -1862,7 +1933,7 @@ declare namespace osAccount { * @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS_EXTENSION * @param { 'activate' | 'activating' } type - Event type. * @param { string } name - Indicates the name of subscriber. - * @param { Callback } callback - Asynchronous callback interface. + * @param { Callback } callback - Asynchronous callback interface. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -1871,9 +1942,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid type or name. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'activate' | 'activating', name: string, callback?: Callback): void; + off(type: 'activate' | 'activating', name: string, callback?: Callback): void; /** * Subscribes to the OS account switching event. @@ -1889,7 +1961,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid type. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'switching', callback: Callback): void; @@ -1907,7 +1980,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid type. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'switching', callback?: Callback): void; @@ -1925,7 +1999,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid type. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'switched', callback: Callback): void; @@ -1943,15 +2018,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid type. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'switched', callback?: Callback): void; /** * Gets the bundle ID associated with the specified UID. * - * @param { number } uid - Indicates the target uid. - * @param { AsyncCallback } callback - Indicates the callback for getting the bundle ID associated with the specified UID. + * @param { int } uid - Indicates the target uid. + * @param { AsyncCallback } callback - Indicates the callback for getting the bundle ID associated with the specified UID. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. @@ -1959,15 +2035,16 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid uid. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getBundleIdForUid(uid: number, callback: AsyncCallback): void; + getBundleIdForUid(uid: int, callback: AsyncCallback): void; /** * Gets the bundle ID associated with the specified UID. * - * @param { number } uid - Indicates the target uid. - * @returns { Promise } Returns the bundle ID associated with the specified UID. + * @param { int } uid - Indicates the target uid. + * @returns { Promise } Returns the bundle ID associated with the specified UID. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. @@ -1975,24 +2052,26 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid uid. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getBundleIdForUid(uid: number): Promise; + getBundleIdForUid(uid: int): Promise; /** * Gets the bundle ID associated with the specified UID synchronously. * - * @param { number } uid - Indicates the target uid. - * @returns { number } Returns the bundle ID associated with the specified UID. + * @param { int } uid - Indicates the target uid. + * @returns { int } Returns the bundle ID associated with the specified UID. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. * @throws { BusinessError } 12300002 - Invalid uid. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - getBundleIdForUidSync(uid: number): number; + getBundleIdForUidSync(uid: int): int; /** * Check whether current process belongs to the main account. @@ -2007,7 +2086,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isMainOsAccount(callback: AsyncCallback): void; @@ -2022,7 +2102,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isMainOsAccount(): Promise; @@ -2030,7 +2111,7 @@ declare namespace osAccount { * Gets a list of constraint source types for the specified os account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to query the source type. * @param { AsyncCallback> } callback - Indicates the callback for * getting a list of constraint source types for the specified os account. @@ -2043,10 +2124,11 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getOsAccountConstraintSourceTypes( - localId: number, + localId: int, constraint: string, callback: AsyncCallback> ): void; @@ -2055,7 +2137,7 @@ declare namespace osAccount { * Gets a list of constraint source types for the specified os account. * * @permission ohos.permission.MANAGE_LOCAL_ACCOUNTS - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { string } constraint - Indicates the constraint to query the source type. * @returns { Promise> } Returns a list of constraint source types for the specified os account. * @throws { BusinessError } 201 - Permission denied. @@ -2067,9 +2149,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - getOsAccountConstraintSourceTypes(localId: number, constraint: string): Promise>; + getOsAccountConstraintSourceTypes(localId: int, constraint: string): Promise>; } /** @@ -2077,24 +2160,27 @@ declare namespace osAccount { * * @interface OsAccountInfo * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ interface OsAccountInfo { /** * The local ID of an OS account. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ - localId: number; + localId: int; /** * The local name of an OS account. * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ localName: string; @@ -2104,7 +2190,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ shortName?: string; @@ -2113,7 +2200,8 @@ declare namespace osAccount { * * @type { OsAccountType } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ type: OsAccountType; @@ -2122,7 +2210,8 @@ declare namespace osAccount { * * @type { Array } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ constraints: Array; @@ -2142,7 +2231,8 @@ declare namespace osAccount { * * @type { boolean } * @syscap SystemCapability.Account.OsAccount - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isUnlocked: boolean; @@ -2151,36 +2241,40 @@ declare namespace osAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ photo: string; /** * Os account create time. * - * @type { number } + * @type { long } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - createTime: number; + createTime: long; /** * The last time to log in. * - * @type { number } + * @type { long } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - lastLoginTime: number; + lastLoginTime: long; /** - * Os account serial number. + * Os account serial int. * - * @type { number } + * @type { long } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - serialNumber: number; + serialNumber: long; /** * Os account is activated or not. @@ -2198,7 +2292,8 @@ declare namespace osAccount { * * @type { boolean } * @syscap SystemCapability.Account.OsAccount - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isActivated: boolean; @@ -2208,7 +2303,8 @@ declare namespace osAccount { * @type { ?boolean } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isLoggedIn?: boolean; @@ -2217,7 +2313,8 @@ declare namespace osAccount { * * @type { boolean } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ isCreateCompleted: boolean; @@ -2226,7 +2323,8 @@ declare namespace osAccount { * * @type { distributedAccount.DistributedInfo } * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ distributedInfo: distributedAccount.DistributedInfo; @@ -2235,7 +2333,8 @@ declare namespace osAccount { * * @type { DomainAccountInfo } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ domainInfo: DomainAccountInfo; } @@ -2246,28 +2345,31 @@ declare namespace osAccount { * @typedef OsAccountSwitchEventData * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface OsAccountSwitchEventData { /** * Indicates which OS account to switch from. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - fromAccountId: number; + fromAccountId: int; /** * Indicates which OS account to switch to. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - toAccountId: number; + toAccountId: int; } /** @@ -2276,7 +2378,8 @@ declare namespace osAccount { * @interface CreateOsAccountOptions * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CreateOsAccountOptions { /** @@ -2285,29 +2388,10 @@ declare namespace osAccount { * @type { string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ shortName: string; - - /** - * Indicates the bundles are disallowed to be preinstalled on the OS account. - * - * @type { ?Array } - * @syscap SystemCapability.Account.OsAccount - * @systemapi Hide this for inner system use. - * @since 18 - */ - disallowedPreinstalledBundles?: Array; - - /** - * Indicates the bundles are allowed to be preinstalled on the OS account. - * - * @type { ?Array } - * @syscap SystemCapability.Account.OsAccount - * @systemapi Hide this for inner system use. - * @since 18 - */ - allowedPreinstalledBundles?: Array; } /** @@ -2317,7 +2401,8 @@ declare namespace osAccount { * @interface CreateOsAccountForDomainOptions * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CreateOsAccountForDomainOptions extends CreateOsAccountOptions {} @@ -2326,7 +2411,8 @@ declare namespace osAccount { * * @interface DomainAccountInfo * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DomainAccountInfo { /** @@ -2334,7 +2420,8 @@ declare namespace osAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ domain: string; @@ -2343,7 +2430,8 @@ declare namespace osAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ accountName: string; @@ -2353,7 +2441,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ accountId?: string; @@ -2363,7 +2452,8 @@ declare namespace osAccount { * @type { ?boolean } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isAuthenticated?: boolean; @@ -2372,7 +2462,8 @@ declare namespace osAccount { * * @type { ?string } * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ serverConfigId?: string; } @@ -2380,16 +2471,18 @@ declare namespace osAccount { /** * Enumerates OS account types. * - * @enum { number } OsAccountType + * @enum { int } OsAccountType * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ enum OsAccountType { /** * Indicates the administrator account, which has the permission to manage other OS accounts. * * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ ADMIN = 0, @@ -2397,7 +2490,8 @@ declare namespace osAccount { * Indicates a normal account, which has access to common functions of OS accounts. * * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL, @@ -2405,7 +2499,8 @@ declare namespace osAccount { * Indicates a guest account, which is used to temporarily access the device and may be deleted at any time. * * @syscap SystemCapability.Account.OsAccount - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ GUEST, @@ -2414,7 +2509,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PRIVATE = 1024 } @@ -2424,7 +2520,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 * @name UserAuth */ class UserAuth { @@ -2434,20 +2531,22 @@ declare namespace osAccount { * @throws { BusinessError } 202 - Not system application. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** * Gets version information. * - * @returns { number } Returns the version information. + * @returns { int } Returns the version information. * @throws { BusinessError } 202 - Not system application. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - getVersion(): number; + getVersion(): int; /** * Checks whether the authentication capability is available. @@ -2455,7 +2554,7 @@ declare namespace osAccount { * @permission ohos.permission.ACCESS_USER_AUTH_INTERNAL * @param { AuthType } authType - Indicates the credential type for authentication. * @param { AuthTrustLevel } authTrustLevel - Indicates the trust level of authentication result. - * @returns { number } Returns a status result. + * @returns { int } Returns a status result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -2464,9 +2563,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid authType or authTrustLevel. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number; + getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): int; /** * Gets the property based on the specified request information. @@ -2482,7 +2582,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid request. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Gets the property based on the specified request information. @@ -2499,7 +2600,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getProperty(request: GetPropertyRequest, callback: AsyncCallback): void; @@ -2517,7 +2619,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid request. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Gets the property based on the specified request information. @@ -2534,7 +2637,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getProperty(request: GetPropertyRequest): Promise; @@ -2554,7 +2658,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300102 - The credential does not exist. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getPropertyByCredentialId(credentialId: Uint8Array, keys: Array): Promise; @@ -2572,7 +2677,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid request. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ setProperty(request: SetPropertyRequest, callback: AsyncCallback): void; @@ -2590,7 +2696,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid request. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ setProperty(request: SetPropertyRequest): Promise; @@ -2607,7 +2714,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid remoteNetworkId. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ prepareRemoteAuth(remoteNetworkId: string): Promise; @@ -2636,7 +2744,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300112 - The authentication service is busy. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Executes authentication. @@ -2668,7 +2777,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300211 - Server unreachable. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ auth( challenge: Uint8Array, @@ -2709,7 +2819,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300211 - Server unreachable. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ auth( challenge: Uint8Array, @@ -2723,7 +2834,7 @@ declare namespace osAccount { * Executes user authentication. * * @permission ohos.permission.ACCESS_USER_AUTH_INTERNAL - * @param { number } userId - Indicates the user identification. + * @param { int } userId - Indicates the user identification. * @param { Uint8Array } challenge - Indicates the challenge value. * @param { AuthType } authType - Indicates the authentication type. * @param { AuthTrustLevel } authTrustLevel - Indicates the trust level of authentication result. @@ -2745,13 +2856,14 @@ declare namespace osAccount { * @throws { BusinessError } 12300112 - The authentication service is busy. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Executes user authentication. * * @permission ohos.permission.ACCESS_USER_AUTH_INTERNAL - * @param { number } userId - Indicates the user identification. + * @param { int } userId - Indicates the user identification. * @param { Uint8Array } challenge - Indicates the challenge value. * @param { AuthType } authType - Indicates the authentication type. * @param { AuthTrustLevel } authTrustLevel - Indicates the trust level of authentication result. @@ -2779,10 +2891,11 @@ declare namespace osAccount { * @throws { BusinessError } 12300211 - Server unreachable. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ authUser( - userId: number, + userId: int, challenge: Uint8Array, authType: AuthType, authTrustLevel: AuthTrustLevel, @@ -2802,7 +2915,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid contextId. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ cancelAuth(contextID: Uint8Array): void; } @@ -2812,7 +2926,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 * @name PINAuth */ class PINAuth { @@ -2822,7 +2937,8 @@ declare namespace osAccount { * @throws { BusinessError } 202 - Not system application. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2840,7 +2956,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300103 - The credential inputer already exists. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ registerInputer(inputer: IInputer): void; @@ -2852,7 +2969,8 @@ declare namespace osAccount { * @throws { BusinessError } 202 - Not system application. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ unregisterInputer(): void; } @@ -2862,7 +2980,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 * @name InputerManager */ class InputerManager { @@ -2883,7 +3002,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static registerInputer(authType: AuthType, inputer: IInputer): void; @@ -2900,7 +3020,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static unregisterInputer(authType: AuthType): void; } @@ -2911,28 +3032,31 @@ declare namespace osAccount { * @interface AuthStatusInfo * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthStatusInfo { /** * Indicates the remaining times that authentication can be performed. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - remainTimes: number; + remainTimes: int; /** * Indicates the freezing time before performing the next authentication. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - freezingTime: number; + freezingTime: int; } /** @@ -2941,7 +3065,8 @@ declare namespace osAccount { * @typedef GetDomainAccessTokenOptions * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface GetDomainAccessTokenOptions { /** @@ -2950,7 +3075,8 @@ declare namespace osAccount { * @type { DomainAccountInfo } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ domainAccountInfo: DomainAccountInfo; @@ -2960,7 +3086,8 @@ declare namespace osAccount { * @type { Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ domainAccountToken: Uint8Array; @@ -2970,19 +3097,21 @@ declare namespace osAccount { * @type { Record } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ businessParams: Record; /** * Indicates caller UID. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - callerUid: number; + callerUid: int; } /** @@ -2991,7 +3120,8 @@ declare namespace osAccount { * @typedef GetDomainAccountInfoOptions * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface GetDomainAccountInfoOptions { /** @@ -3000,7 +3130,8 @@ declare namespace osAccount { * @type { string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ accountName: string; @@ -3010,7 +3141,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ domain?: string; @@ -3020,7 +3152,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ serverConfigId?: string; } @@ -3032,18 +3165,20 @@ declare namespace osAccount { * @extends GetDomainAccountInfoOptions * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface GetDomainAccountInfoPluginOptions extends GetDomainAccountInfoOptions { /** * Indicates the caller UID. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - callerUid: number; + callerUid: int; } /** @@ -3052,7 +3187,8 @@ declare namespace osAccount { * @interface DomainPlugin * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DomainPlugin { /** @@ -3063,7 +3199,8 @@ declare namespace osAccount { * @param { IUserAuthCallback } callback - Indicates the authentication callback. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUserAuthCallback): void; @@ -3074,7 +3211,8 @@ declare namespace osAccount { * @param { IUserAuthCallback } callback - Indicates the callback for notifying the authentication result. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ authWithPopup(domainAccountInfo: DomainAccountInfo, callback: IUserAuthCallback): void; @@ -3086,7 +3224,8 @@ declare namespace osAccount { * @param { IUserAuthCallback } callback - Indicates the callback for notifying the authentication result. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ authWithToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array, callback: IUserAuthCallback): void; @@ -3097,7 +3236,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Indicates the callback for notifying the domain account information. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ getAccountInfo(options: GetDomainAccountInfoPluginOptions, callback: AsyncCallback): void; @@ -3108,7 +3248,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Indicates the callback for notifying the domain authentication status information. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthStatusInfo(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback): void; @@ -3116,13 +3257,14 @@ declare namespace osAccount { * Binds the specified domain account with an OS account. * * @param { DomainAccountInfo } domainAccountInfo - Indicates the domain account information. - * @param { number } localId - Indicates the local ID of the OS account. + * @param { int } localId - Indicates the local ID of the OS account. * @param { AsyncCallback } callback - Indicates the callback for notifying the binding result. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - bindAccount(domainAccountInfo: DomainAccountInfo, localId: number, callback: AsyncCallback): void; + bindAccount(domainAccountInfo: DomainAccountInfo, localId: int, callback: AsyncCallback): void; /** * Unbind the specified domain account. @@ -3131,7 +3273,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Indicates the callback for notifying the unbinding result. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ unbindAccount(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback): void; @@ -3143,7 +3286,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Indicates the callback for notifying the checking result. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isAccountTokenValid( domainAccountInfo: DomainAccountInfo, @@ -3158,7 +3302,8 @@ declare namespace osAccount { * @param { AsyncCallback } callback - Indicates the callback for returning the access token. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ getAccessToken(options: GetDomainAccessTokenOptions, callback: AsyncCallback): void; } @@ -3167,7 +3312,8 @@ declare namespace osAccount { * Provides abilities for the management of domain account. * * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ class DomainAccountManager { /** @@ -3183,7 +3329,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Registers the domain plugin, which provides the capabilities for domain authentication. @@ -3199,7 +3346,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static registerPlugin(plugin: DomainPlugin): void; @@ -3212,7 +3360,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Unregisters domain plugin. @@ -3224,7 +3373,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static unregisterPlugin(): void; @@ -3254,7 +3404,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300211 - Server unreachable. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static auth(domainAccountInfo: DomainAccountInfo, credential: Uint8Array, callback: IUserAuthCallback): void; @@ -3281,7 +3432,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Authenticates the domain account bound to the current OS account with a popup. @@ -3305,7 +3457,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ static authWithPopup(callback: IUserAuthCallback): void; @@ -3313,7 +3466,7 @@ declare namespace osAccount { * Authenticates the domain account bound to the specified OS account with a popup. * * @permission ohos.permission.ACCESS_USER_AUTH_INTERNAL - * @param { number } localId - Indicates the local ID of the specified OS account. + * @param { int } localId - Indicates the local ID of the specified OS account. * @param { IUserAuthCallback } callback - Indicates the callback for getting the authentication result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -3334,12 +3487,13 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Authenticates the domain account bound to the specified OS account with a popup. * - * @param { number } localId - Indicates the local ID of the specified OS account. + * @param { int } localId - Indicates the local ID of the specified OS account. * @param { IUserAuthCallback } callback - Indicates the callback for getting the authentication result. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. @@ -3360,9 +3514,10 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - static authWithPopup(localId: number, callback: IUserAuthCallback): void; + static authWithPopup(localId: int, callback: IUserAuthCallback): void; /** * Checks whether the specified domain account exists. @@ -3385,7 +3540,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static hasAccount(domainAccountInfo: DomainAccountInfo, callback: AsyncCallback): void; @@ -3410,7 +3566,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static hasAccount(domainAccountInfo: DomainAccountInfo): Promise; @@ -3433,7 +3590,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static updateAccountToken( domainAccountInfo: DomainAccountInfo, @@ -3460,7 +3618,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static updateAccountToken(domainAccountInfo: DomainAccountInfo, token: Uint8Array): Promise; @@ -3472,8 +3631,6 @@ declare namespace osAccount { * @param { DomainAccountInfo } newAccountInfo - Indicates the new domain account information. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - The new account info is invalid. @@ -3481,7 +3638,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300004 - The new account already exists. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static updateAccountInfo(oldAccountInfo: DomainAccountInfo, newAccountInfo: DomainAccountInfo): Promise; @@ -3506,7 +3664,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAccountInfo(options: GetDomainAccountInfoOptions, callback: AsyncCallback): void; @@ -3531,7 +3690,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAccountInfo(options: GetDomainAccountInfoOptions): Promise; @@ -3555,7 +3715,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAccessToken(businessParams: Record, callback: AsyncCallback): void; @@ -3579,7 +3740,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAccessToken(businessParams: Record): Promise; @@ -3599,7 +3761,8 @@ declare namespace osAccount { * @static * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static isAuthenticationExpired(domainAccountInfo: DomainAccountInfo): Promise; } @@ -3609,7 +3772,8 @@ declare namespace osAccount { * * @typedef DomainServerConfig * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DomainServerConfig { /** @@ -3617,7 +3781,8 @@ declare namespace osAccount { * * @type { Record } * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters: Record; @@ -3626,7 +3791,8 @@ declare namespace osAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ id: string; @@ -3635,7 +3801,8 @@ declare namespace osAccount { * * @type { string } * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ domain: string; } @@ -3644,7 +3811,8 @@ declare namespace osAccount { * Provides abilities for managing domain server config. * * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ class DomainServerConfigManager { /** @@ -3654,8 +3822,6 @@ declare namespace osAccount { * @param { Record } parameters - Indicates the server config parameters. * @returns { Promise } Returns the added domain server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid server config parameters. @@ -3664,7 +3830,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300215 - The number of server config reaches the upper limit. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static addServerConfig(parameters: Record): Promise; @@ -3675,15 +3842,14 @@ declare namespace osAccount { * @param { string } configId - Indicates the server config identifier. * @returns { Promise } Returns void. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300212 - Server config not found. * @throws { BusinessError } 12300214 - Server config has been associated with an account. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static removeServerConfig(configId: string): Promise; @@ -3695,8 +3861,6 @@ declare namespace osAccount { * @param { Record } parameters - Indicates the server config parameters. * @returns { Promise } Returns the updated domain server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300002 - Invalid server config parameters. @@ -3706,7 +3870,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300214 - Server config has been associated with an account. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static updateServerConfig(configId: string, parameters: Record): Promise; @@ -3717,14 +3882,13 @@ declare namespace osAccount { * @param { string } configId - Indicates the server config identifier. * @returns { Promise } Returns the server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300212 - Server config not found. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getServerConfig(configId: string): Promise; @@ -3738,7 +3902,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAllServerConfigs(): Promise>; @@ -3749,14 +3914,13 @@ declare namespace osAccount { * @param { DomainAccountInfo } domainAccountInfo - Indicates the domain account information. * @returns { Promise } Returns the domain server config. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. - *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 12300001 - The system service works abnormally. * @throws { BusinessError } 12300003 - Domain account not found. * @static * @syscap SystemCapability.Account.OsAccount - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAccountServerConfig(domainAccountInfo: DomainAccountInfo): Promise; } @@ -3766,7 +3930,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 * @name UserIdentityManager */ class UserIdentityManager { @@ -3776,7 +3941,8 @@ declare namespace osAccount { * @throws { BusinessError } 202 - Not system application. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3795,7 +3961,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ openSession(callback: AsyncCallback): void; @@ -3813,7 +3980,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Opens a session. @@ -3821,7 +3989,7 @@ declare namespace osAccount { * Start an IDM operation to obtain challenge value. * * @permission ohos.permission.MANAGE_USER_IDM - * @param { number } [accountId] - Indicates the local ID of the OS account. + * @param { int } [accountId] - Indicates the local ID of the OS account. * @returns { Promise } Returns a challenge value. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -3831,9 +3999,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - openSession(accountId?: number): Promise; + openSession(accountId?: int): Promise; /** * Adds credential. @@ -3858,7 +4027,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300115 - The number of credentials reaches the upper limit. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Adds a credential. @@ -3886,7 +4056,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300116 - Credential complexity verification failed. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ addCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; @@ -3909,7 +4080,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300111 - The operation time out. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Updates a credential. @@ -3932,7 +4104,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300116 - Credential complexity verification failed. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ updateCredential(credentialInfo: CredentialInfo, callback: IIdmCallback): void; @@ -3946,7 +4119,8 @@ declare namespace osAccount { * @throws { BusinessError } 202 - Not system application. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Closes a session. @@ -3954,7 +4128,7 @@ declare namespace osAccount { * End an IDM operation. * * @permission ohos.permission.MANAGE_USER_IDM - * @param { number } [accountId] - Indicates the local ID of the OS account. + * @param { int } [accountId] - Indicates the local ID of the OS account. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. @@ -3963,9 +4137,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300008 - Restricted account. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - closeSession(accountId?: number): void; + closeSession(accountId?: int): void; /** * Cancels entry with a challenge value. @@ -3980,7 +4155,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid challenge. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ cancel(challenge: Uint8Array): void; @@ -3998,7 +4174,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300101 - The token is invalid. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ delUser(token: Uint8Array, callback: IIdmCallback): void; @@ -4019,7 +4196,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300102 - The credential does not exist. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ delCred(credentialId: Uint8Array, token: Uint8Array, callback: IIdmCallback): void; @@ -4036,7 +4214,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300001 - The system service works abnormally. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthInfo(callback: AsyncCallback>): void; @@ -4055,7 +4234,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid authType. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthInfo(authType: AuthType, callback: AsyncCallback>): void; @@ -4073,9 +4253,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid authType. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - getAuthInfo(authType?: AuthType): Promise>; + getAuthInfo(authType: AuthType): Promise>; /** * Gets authentication information. @@ -4092,7 +4273,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300003 - Account not found. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getAuthInfo(options?: GetAuthInfoOptions): Promise>; @@ -4101,7 +4283,7 @@ declare namespace osAccount { * * @permission ohos.permission.USE_USER_IDM * @param { AuthType } authType - Indicates the authentication type. - * @param { number } [accountId] - Indicates the OS account identifier. + * @param { int } [accountId] - Indicates the OS account identifier. * @returns { Promise } Returns the enrolled identifier. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not system application. @@ -4114,9 +4296,10 @@ declare namespace osAccount { * @throws { BusinessError } 12300106 - The authentication type is not supported. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getEnrolledId(authType: AuthType, accountId?: number): Promise; + getEnrolledId(authType: AuthType, accountId?: int): Promise; } /** @@ -4125,7 +4308,8 @@ declare namespace osAccount { * @typedef GetAuthInfoOptions * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface GetAuthInfoOptions { /** @@ -4134,28 +4318,31 @@ declare namespace osAccount { * @type { ?AuthType } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ authType?: AuthType; /** * Indicates the OS account identifier. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - accountId?: number; + accountId?: int; } /** * Indicates the enumeration of the authentication intent. * - * @enum { number } AuthIntent + * @enum { int } AuthIntent * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum AuthIntent { /** @@ -4163,7 +4350,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UNLOCK = 1, @@ -4172,7 +4360,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SILENT_AUTH = 2, @@ -4181,7 +4370,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ QUESTION_AUTH = 3, } @@ -4192,7 +4382,8 @@ declare namespace osAccount { * @interface RemoteAuthOptions * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface RemoteAuthOptions { /** @@ -4201,7 +4392,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ verifierNetworkId?: string; @@ -4211,19 +4403,21 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ collectorNetworkId?: string; /** * Indicates the collector token identifier. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - collectorTokenId?: number; + collectorTokenId?: int; } /** @@ -4232,18 +4426,20 @@ declare namespace osAccount { * @interface AuthOptions * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthOptions { /** * Indicates the local ID of the OS account to be authenticated. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - accountId?: number; + accountId?: int; /** * Indicates the authentication intent. @@ -4251,7 +4447,8 @@ declare namespace osAccount { * @type { ?AuthIntent } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ authIntent?: AuthIntent; @@ -4261,7 +4458,8 @@ declare namespace osAccount { * @type { ?RemoteAuthOptions } * @syscap SystemCapability.Account.OsAccount * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ remoteAuthOptions?: RemoteAuthOptions; } @@ -4272,7 +4470,8 @@ declare namespace osAccount { * @interface IInputData * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface IInputData { /** @@ -4285,7 +4484,8 @@ declare namespace osAccount { * @throws { BusinessError } 12300002 - Invalid pinSubType. * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ onSetData: (authSubType: AuthSubType, data: Uint8Array) => void; } @@ -4296,7 +4496,8 @@ declare namespace osAccount { * @interface GetInputDataOptions * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface GetInputDataOptions { /** @@ -4305,7 +4506,8 @@ declare namespace osAccount { * @type { ?Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ challenge?: Uint8Array; } @@ -4316,7 +4518,8 @@ declare namespace osAccount { * @interface IInputer * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface IInputer { /** @@ -4325,7 +4528,8 @@ declare namespace osAccount { * @type { function } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ onGetData: (authSubType: AuthSubType, callback: IInputData, options: GetInputDataOptions) => void; } @@ -4336,7 +4540,8 @@ declare namespace osAccount { * @interface IUserAuthCallback * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface IUserAuthCallback { /** @@ -4348,9 +4553,10 @@ declare namespace osAccount { * @type { function } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - onResult: (result: number, extraInfo: AuthResult) => void; + onResult: (result: int, extraInfo: AuthResult) => void; /** * During an authentication, the TipsCode is returned through the callback. @@ -4358,9 +4564,10 @@ declare namespace osAccount { * @type { ?function } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - onAcquireInfo?: (module: number, acquire: number, extraInfo: Uint8Array) => void; + onAcquireInfo?: (module: int, acquire: int, extraInfo: Uint8Array) => void; } /** @@ -4369,7 +4576,8 @@ declare namespace osAccount { * @interface IIdmCallback * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface IIdmCallback { /** @@ -4378,9 +4586,10 @@ declare namespace osAccount { * @type { function } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - onResult: (result: number, extraInfo: RequestResult) => void; + onResult: (result: int, extraInfo: RequestResult) => void; /** * During an authentication, the TipsCode is returned through the callback. @@ -4388,9 +4597,10 @@ declare namespace osAccount { * @type { ?function } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - onAcquireInfo?: (module: number, acquire: number, extraInfo: Uint8Array) => void; + onAcquireInfo?: (module: int, acquire: int, extraInfo: Uint8Array) => void; } /** @@ -4399,7 +4609,8 @@ declare namespace osAccount { * @interface GetPropertyRequest * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface GetPropertyRequest { /** @@ -4408,7 +4619,8 @@ declare namespace osAccount { * @type { AuthType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ authType: AuthType; @@ -4418,19 +4630,21 @@ declare namespace osAccount { * @type { Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ keys: Array; /** * Indicates the OS account identifier. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - accountId?: number; + accountId?: int; } /** @@ -4439,7 +4653,8 @@ declare namespace osAccount { * @interface SetPropertyRequest * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SetPropertyRequest { /** @@ -4448,7 +4663,8 @@ declare namespace osAccount { * @type { AuthType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ authType: AuthType; @@ -4458,7 +4674,8 @@ declare namespace osAccount { * @type { SetPropertyType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ key: SetPropertyType; @@ -4468,7 +4685,8 @@ declare namespace osAccount { * @type { Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ setInfo: Uint8Array; } @@ -4479,18 +4697,20 @@ declare namespace osAccount { * @interface ExecutorProperty * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ExecutorProperty { /** * Indicates the result. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - result: number; + result: int; /** * Indicates the authentication credential subtype. @@ -4498,39 +4718,43 @@ declare namespace osAccount { * @type { AuthSubType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ authSubType: AuthSubType; /** * Indicates the remaining times. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - remainTimes?: number; + remainTimes?: int; /** * Indicates the freezing times. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - freezingTime?: number; + freezingTime?: int; /** * Indicates next phase freezing time. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - nextPhaseFreezingTime?: number; + nextPhaseFreezingTime?: int; /** * Indicates the enrollment progress. @@ -4538,7 +4762,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enrollmentProgress?: string; @@ -4548,7 +4773,8 @@ declare namespace osAccount { * @type { ?string } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ sensorInfo?: string; } @@ -4559,7 +4785,8 @@ declare namespace osAccount { * @interface AuthResult * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AuthResult { /** @@ -4568,39 +4795,43 @@ declare namespace osAccount { * @type { ?Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ token?: Uint8Array; /** * Indicates the remaining times. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - remainTimes?: number; + remainTimes?: int; /** * Indicates the freezing times. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - freezingTime?: number; + freezingTime?: int; /** * Indicates next phase freezing time. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - nextPhaseFreezingTime?: number; + nextPhaseFreezingTime?: int; /** * Indicates the credential ID. @@ -4608,29 +4839,32 @@ declare namespace osAccount { * @type { ?Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ credentialId?: Uint8Array; /** * Indicates the local ID of the authenticated OS account. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - accountId?: number; + accountId?: int; /** * Indicates the validity period after which the PIN will expire. * - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - pinValidityPeriod?: number; + pinValidityPeriod?: long; } /** @@ -4639,7 +4873,8 @@ declare namespace osAccount { * @interface CredentialInfo * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CredentialInfo { /** @@ -4648,7 +4883,8 @@ declare namespace osAccount { * @type { AuthType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ credType: AuthType; @@ -4658,7 +4894,8 @@ declare namespace osAccount { * @type { AuthSubType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ credSubType: AuthSubType; @@ -4668,19 +4905,21 @@ declare namespace osAccount { * @type { Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ token: Uint8Array; /** * Indicates the local ID of the OS account to which the credential belongs. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - accountId?: number; + accountId?: int; } /** @@ -4689,7 +4928,8 @@ declare namespace osAccount { * @interface RequestResult * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestResult { /** @@ -4698,7 +4938,8 @@ declare namespace osAccount { * @type { ?Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ credentialId?: Uint8Array; } @@ -4709,7 +4950,8 @@ declare namespace osAccount { * @interface EnrolledCredInfo * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface EnrolledCredInfo { /** @@ -4718,7 +4960,8 @@ declare namespace osAccount { * @type { Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ credentialId: Uint8Array; @@ -4728,7 +4971,8 @@ declare namespace osAccount { * @type { AuthType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ authType: AuthType; @@ -4738,7 +4982,8 @@ declare namespace osAccount { * @type { AuthSubType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ authSubType: AuthSubType; @@ -4748,7 +4993,8 @@ declare namespace osAccount { * @type { Uint8Array } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ templateId: Uint8Array; } @@ -4756,10 +5002,11 @@ declare namespace osAccount { /** * Indicates the property type to get. * - * @enum { number } GetPropertyType + * @enum { int } GetPropertyType * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum GetPropertyType { /** @@ -4767,7 +5014,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTH_SUB_TYPE = 1, @@ -4776,7 +5024,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ REMAIN_TIMES = 2, @@ -4785,7 +5034,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FREEZING_TIME = 3, @@ -4794,7 +5044,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ENROLLMENT_PROGRESS = 4, @@ -4803,7 +5054,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SENSOR_INFO = 5, @@ -4812,7 +5064,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NEXT_PHASE_FREEZING_TIME = 6 } @@ -4820,10 +5073,11 @@ declare namespace osAccount { /** * Indicates the property type to set. * - * @enum { number } SetPropertyType + * @enum { int } SetPropertyType * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum SetPropertyType { /** @@ -4831,7 +5085,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ INIT_ALGORITHM = 1 } @@ -4839,10 +5094,11 @@ declare namespace osAccount { /** * Indicates the credential type for authentication. * - * @enum { number } AuthType + * @enum { int } AuthType * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum AuthType { /** @@ -4850,7 +5106,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN = 1, @@ -4859,7 +5116,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE = 2, @@ -4868,7 +5126,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT = 4, @@ -4877,7 +5136,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RECOVERY_KEY = 8, @@ -4886,7 +5146,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ PRIVATE_PIN = 16, @@ -4895,7 +5156,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DOMAIN = 1024 } @@ -4903,10 +5165,11 @@ declare namespace osAccount { /** * Indicates the credential subtype for authentication. * - * @enum { number } AuthSubType + * @enum { int } AuthSubType * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum AuthSubType { /** @@ -4914,7 +5177,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN_SIX = 10000, @@ -4923,7 +5187,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN_NUMBER = 10001, @@ -4932,7 +5197,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN_MIXED = 10002, @@ -4941,7 +5207,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN_FOUR = 10003, @@ -4950,7 +5217,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN_PATTERN = 10004, @@ -4959,7 +5227,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ PIN_QUESTION = 10005, @@ -4968,7 +5237,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_2D = 20000, @@ -4977,7 +5247,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_3D = 20001, @@ -4986,7 +5257,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_CAPACITIVE = 30000, @@ -4995,7 +5267,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_OPTICAL = 30001, @@ -5004,7 +5277,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_ULTRASONIC = 30002, @@ -5013,7 +5287,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DOMAIN_MIXED = 10240001 } @@ -5021,10 +5296,11 @@ declare namespace osAccount { /** * Indicates the trusted level of authentication results. * - * @enum { number } AuthTrustLevel + * @enum { int } AuthTrustLevel * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum AuthTrustLevel { /** @@ -5032,7 +5308,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ATL1 = 10000, @@ -5041,7 +5318,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ATL2 = 20000, @@ -5050,7 +5328,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ATL3 = 30000, @@ -5059,7 +5338,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ATL4 = 40000 } @@ -5067,10 +5347,11 @@ declare namespace osAccount { /** * Indicates the module of acquired information. * - * @enum { number } Module + * @enum { int } Module * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum Module { /** @@ -5078,7 +5359,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH = 1 } @@ -5086,10 +5368,11 @@ declare namespace osAccount { /** * Indicates the enumeration of authentication result code. * - * @enum { number } ResultCode + * @enum { int } ResultCode * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ResultCode { /** @@ -5097,7 +5380,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ SUCCESS = 0, @@ -5106,7 +5390,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FAIL = 1, @@ -5115,7 +5400,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ GENERAL_ERROR = 2, @@ -5124,7 +5410,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCELED = 3, @@ -5133,7 +5420,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ TIMEOUT = 4, @@ -5142,7 +5430,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_NOT_SUPPORT = 5, @@ -5151,7 +5440,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ TRUST_LEVEL_NOT_SUPPORT = 6, @@ -5160,7 +5450,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ BUSY = 7, @@ -5169,7 +5460,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ INVALID_PARAMETERS = 8, @@ -5178,7 +5470,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ LOCKED = 9, @@ -5187,7 +5480,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ NOT_ENROLLED = 10 } @@ -5195,10 +5489,11 @@ declare namespace osAccount { /** * Indicates the enumeration of prompt codes in the process of face authentication. * - * @enum { number } FaceTipsCode + * @enum { int } FaceTipsCode * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FaceTipsCode { /** @@ -5206,7 +5501,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_BRIGHT = 1, @@ -5215,7 +5511,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_DARK = 2, @@ -5224,7 +5521,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_CLOSE = 3, @@ -5233,7 +5531,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_FAR = 4, @@ -5242,7 +5541,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_HIGH = 5, @@ -5251,7 +5551,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_LOW = 6, @@ -5260,7 +5561,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_RIGHT = 7, @@ -5269,7 +5571,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_LEFT = 8, @@ -5278,7 +5581,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, @@ -5287,7 +5591,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_POOR_GAZE = 10, @@ -5296,7 +5601,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FACE_AUTH_TIP_NOT_DETECTED = 11 } @@ -5304,10 +5610,11 @@ declare namespace osAccount { /** * Indicates the enumeration of prompt codes in the process of fingerprint authentication. * - * @enum { number } FingerprintTips + * @enum { int } FingerprintTips * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FingerprintTips { /** @@ -5315,7 +5622,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_GOOD = 0, @@ -5324,7 +5632,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_IMAGER_DIRTY = 1, @@ -5333,7 +5642,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_INSUFFICIENT = 2, @@ -5342,7 +5652,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_PARTIAL = 3, @@ -5351,7 +5662,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_TOO_FAST = 4, @@ -5360,7 +5672,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_TOO_SLOW = 5, @@ -5369,7 +5682,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_FINGER_DOWN = 6, @@ -5378,7 +5692,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGERPRINT_TIP_FINGER_UP = 7 } @@ -5386,10 +5701,11 @@ declare namespace osAccount { /** * Enumerates for constraint source types. * - * @enum { number } ConstraintSourceType + * @enum { int } ConstraintSourceType * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ConstraintSourceType { /** @@ -5397,7 +5713,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CONSTRAINT_NOT_EXIST = 0, @@ -5406,7 +5723,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CONSTRAINT_TYPE_BASE = 1, @@ -5415,7 +5733,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CONSTRAINT_TYPE_DEVICE_OWNER = 2, @@ -5424,7 +5743,8 @@ declare namespace osAccount { * * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CONSTRAINT_TYPE_PROFILE_OWNER = 3 } @@ -5435,19 +5755,21 @@ declare namespace osAccount { * @interface ConstraintSourceTypeInfo * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ConstraintSourceTypeInfo { /** * Indicates the id of an os account who set the constraint. * When type is CONSTRAINT_NOT_EXIST or CONSTRAINT_TYPE_BASE, localId will be -1. * - * @type { number } + * @type { int } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - localId: number; + localId: int; /** * Indicates the source type of the constraint. @@ -5455,7 +5777,8 @@ declare namespace osAccount { * @type { ConstraintSourceType } * @syscap SystemCapability.Account.OsAccount * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ConstraintSourceType; } diff --git a/api/@ohos.animator.d.ts b/api/@ohos.animator.d.ts index 296ec868c8fe17df89b1d98cdb927b1f1e069910..7b40c6e1ec838c62541ade25dc2380d6f1021b24 100644 --- a/api/@ohos.animator.d.ts +++ b/api/@ohos.animator.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { FillMode, PlayMode } from './arkui/component/enums'; +import { ExpectedFrameRateRange } from './arkui/component/common'; +/*** endif */ + /** * Defines the animator options. * @interface AnimatorOptions @@ -37,7 +42,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface AnimatorOptions { /** @@ -62,7 +68,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration: number; @@ -134,7 +141,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ easing: string; @@ -160,7 +168,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ delay: number; @@ -189,7 +198,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ fill: "none" | "forwards" | "backwards" | "both"; @@ -215,7 +225,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ direction: "normal" | "reverse" | "alternate" | "alternate-reverse"; @@ -241,7 +252,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ iterations: number; @@ -267,7 +279,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ begin: number; @@ -293,7 +306,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ end: number; } @@ -304,7 +318,8 @@ export interface AnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export declare class SimpleAnimatorOptions { /** @@ -315,7 +330,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(begin: number, end: number); @@ -327,7 +343,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ duration(duration: number): SimpleAnimatorOptions; @@ -353,7 +370,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ easing(curve: string): SimpleAnimatorOptions; @@ -365,7 +383,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ delay(delay: number): SimpleAnimatorOptions; @@ -377,7 +396,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ fill(fillMode: FillMode): SimpleAnimatorOptions; @@ -389,7 +409,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ direction(direction: PlayMode): SimpleAnimatorOptions; @@ -401,7 +422,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ iterations(iterations: number): SimpleAnimatorOptions; } @@ -425,7 +447,8 @@ export declare class SimpleAnimatorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface AnimatorResult { /** @@ -472,7 +495,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reset(options: AnimatorOptions): void; @@ -487,7 +511,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ reset(options: AnimatorOptions | SimpleAnimatorOptions): void; @@ -507,7 +532,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ play(): void; @@ -527,7 +553,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ finish(): void; @@ -547,7 +574,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pause(): void; @@ -567,7 +595,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cancel(): void; @@ -588,7 +617,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reverse(): void; @@ -621,7 +651,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onFrame: (progress: number) => void; @@ -654,7 +685,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onFinish: () => void; @@ -687,7 +719,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onCancel: () => void; @@ -720,7 +753,8 @@ export interface AnimatorResult { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onRepeat: () => void; @@ -729,7 +763,8 @@ export interface AnimatorResult { * @param { ExpectedFrameRateRange } rateRange - Indicates ExpectedFrameRateRange. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setExpectedFrameRateRange(rateRange: ExpectedFrameRateRange): void; } @@ -752,7 +787,15 @@ export interface AnimatorResult { * @atomicservice * @since 11 */ -export default class Animator { +/** + * Defines the Animator class. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +declare class Animator { /** * Create an animator object for custom animation. * @param { AnimatorOptions } options - Options. @@ -815,7 +858,10 @@ export default class Animator { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ static create(options: AnimatorOptions | SimpleAnimatorOptions): AnimatorResult; } + +export default Animator; diff --git a/api/@ohos.app.ability.Ability.d.ts b/api/@ohos.app.ability.Ability.d.ts index d75c045d96e6fcca3e84dcb082f4ba00428ad41a..bd866f61ab48acc9cf7cc6716b52891fd14ff1fe 100644 --- a/api/@ohos.app.ability.Ability.d.ts +++ b/api/@ohos.app.ability.Ability.d.ts @@ -18,8 +18,10 @@ * @kit AbilityKit */ +/*** if arkts 1.1 */ import AbilityConstant from './@ohos.app.ability.AbilityConstant'; import { Configuration } from './@ohos.app.ability.Configuration'; +/*** endif */ /** * The class of an ability. @@ -34,9 +36,11 @@ import { Configuration } from './@ohos.app.ability.Configuration'; * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class Ability { +declare class Ability { + /** * Called when the system configuration is updated. * @@ -79,3 +83,5 @@ export default class Ability { */ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; } + +export default Ability; diff --git a/api/@ohos.app.ability.AbilityConstant.d.ts b/api/@ohos.app.ability.AbilityConstant.d.ts index 0275e7848d5276c65abcd915a7630c25a51b4abc..660207d7ed248a4300e9bdaec29c49861926334e 100644 --- a/api/@ohos.app.ability.AbilityConstant.d.ts +++ b/api/@ohos.app.ability.AbilityConstant.d.ts @@ -43,7 +43,8 @@ * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace AbilityConstant { /** @@ -71,7 +72,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface LaunchParam { /** @@ -99,7 +101,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ launchReason: LaunchReason; @@ -110,7 +113,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ launchReasonMessage?: string; @@ -139,7 +143,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ lastExitReason: LastExitReason; @@ -150,7 +155,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ lastExitMessage: string; @@ -161,7 +167,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ lastExitDetailInfo?: LastExitDetailInfo; } @@ -173,7 +180,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface LastExitDetailInfo { /** @@ -183,7 +191,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ pid: number; @@ -194,7 +203,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ processName: string; @@ -205,7 +215,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ uid: number; @@ -216,7 +227,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ exitSubReason: number; @@ -227,7 +239,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ exitMsg: string; @@ -238,7 +251,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ rss: number; @@ -249,7 +263,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ pss: number; @@ -260,7 +275,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; } @@ -290,7 +306,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum LaunchReason { /** @@ -311,7 +328,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, @@ -328,7 +346,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ START_ABILITY = 1, @@ -345,7 +364,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CALL = 2, @@ -362,7 +382,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUATION = 3, @@ -379,7 +400,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_RECOVERY = 4, @@ -396,7 +418,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SHARE = 5, @@ -405,7 +428,8 @@ declare namespace AbilityConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_STARTUP = 8, @@ -415,7 +439,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ INSIGHT_INTENT = 9, @@ -425,7 +450,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PREPARE_CONTINUATION = 10, } @@ -455,7 +481,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum LastExitReason { /** @@ -483,7 +510,8 @@ declare namespace AbilityConstant { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, @@ -511,7 +539,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 2, @@ -528,7 +557,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CPP_CRASH = 3, @@ -545,7 +575,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JS_ERROR = 4, @@ -562,7 +593,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_FREEZE = 5, @@ -579,7 +611,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PERFORMANCE_CONTROL = 6, @@ -596,7 +629,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ RESOURCE_CONTROL = 7, @@ -613,7 +647,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UPGRADE = 8, @@ -623,7 +658,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ USER_REQUEST = 9, @@ -633,7 +669,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SIGNAL = 10 } @@ -653,7 +690,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum OnContinueResult { /** @@ -669,7 +707,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AGREE = 0, @@ -686,7 +725,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ REJECT = 1, @@ -703,7 +743,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MISMATCH = 2 } @@ -723,7 +764,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum MemoryLevel { /** @@ -739,7 +781,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MEMORY_LEVEL_MODERATE = 0, @@ -756,7 +799,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MEMORY_LEVEL_LOW = 1, @@ -773,7 +817,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MEMORY_LEVEL_CRITICAL = 2 } @@ -784,7 +829,8 @@ declare namespace AbilityConstant { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum WindowMode { /** @@ -793,7 +839,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW_MODE_UNDEFINED = 0, @@ -802,7 +849,8 @@ declare namespace AbilityConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW_MODE_FULLSCREEN = 1, @@ -812,7 +860,8 @@ declare namespace AbilityConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW_MODE_SPLIT_PRIMARY = 100, @@ -822,7 +871,8 @@ declare namespace AbilityConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW_MODE_SPLIT_SECONDARY = 101, @@ -832,7 +882,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW_MODE_FLOATING = 102 } @@ -852,7 +903,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum OnSaveResult { /** @@ -868,7 +920,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ALL_AGREE = 0, @@ -885,7 +938,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUATION_REJECT = 1, @@ -902,7 +956,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUATION_MISMATCH = 2, @@ -919,7 +974,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ RECOVERY_AGREE = 3, @@ -936,7 +992,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ RECOVERY_REJECT = 4, @@ -953,7 +1010,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ALL_REJECT } @@ -973,7 +1031,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum StateType { /** @@ -989,7 +1048,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTINUATION = 0, @@ -1006,7 +1066,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_RECOVERY = 1 } @@ -1026,7 +1087,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ContinueState { /** @@ -1042,7 +1104,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTIVE = 0, @@ -1059,7 +1122,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ INACTIVE = 1 } @@ -1070,7 +1134,8 @@ declare namespace AbilityConstant { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum CollaborateResult { /** @@ -1078,7 +1143,8 @@ declare namespace AbilityConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ ACCEPT = 0, @@ -1087,7 +1153,8 @@ declare namespace AbilityConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ REJECT = 1, } @@ -1099,7 +1166,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PrepareTermination { /** @@ -1108,7 +1176,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ TERMINATE_IMMEDIATELY = 0, @@ -1118,7 +1187,8 @@ declare namespace AbilityConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 1 } diff --git a/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts b/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts index d7351fe2290935f0f2316d9c916208baf0251ecb..3385c6251ea0c3f06e11d82e759ab30354780f81 100644 --- a/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts +++ b/api/@ohos.app.ability.AbilityLifecycleCallback.d.ts @@ -18,8 +18,8 @@ * @kit AbilityKit */ -import UIAbility from './@ohos.app.ability.UIAbility'; import dataAbility from './@ohos.data.dataAbility'; +import UIAbility from './@ohos.app.ability.UIAbility'; import window from './@ohos.window'; /** @@ -46,7 +46,7 @@ import window from './@ohos.window'; * @atomicservice * @since 11 */ -export default class AbilityLifecycleCallback { +declare class AbilityLifecycleCallback { /** * Called back when an ability is started for initialization. * @@ -435,3 +435,5 @@ export default class AbilityLifecycleCallback { */ onAbilitySaveState?(ability: UIAbility): void; } + +export default AbilityLifecycleCallback; \ No newline at end of file diff --git a/api/@ohos.app.ability.AbilityStage.d.ts b/api/@ohos.app.ability.AbilityStage.d.ts index 9347e97d8852a64251cf3fc9a3978380bfc5e8ce..d202bcc535c20611cff6ef393482f4bc09a4a914 100644 --- a/api/@ohos.app.ability.AbilityStage.d.ts +++ b/api/@ohos.app.ability.AbilityStage.d.ts @@ -45,9 +45,10 @@ import { Configuration } from './@ohos.app.ability.Configuration'; * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class AbilityStage { +declare class AbilityStage { /** * Indicates configuration information about context. * @@ -73,7 +74,8 @@ export default class AbilityStage { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ context: AbilityStageContext; @@ -99,7 +101,8 @@ export default class AbilityStage { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onCreate(): void; @@ -165,7 +168,8 @@ export default class AbilityStage { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onConfigurationUpdate(newConfig: Configuration): void; @@ -197,7 +201,8 @@ export default class AbilityStage { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onDestroy(): void; @@ -228,3 +233,5 @@ export default class AbilityStage { */ onPrepareTerminationAsync(): Promise; } + +export default AbilityStage; \ No newline at end of file diff --git a/api/@ohos.app.ability.ApplicationStateChangeCallback.d.ts b/api/@ohos.app.ability.ApplicationStateChangeCallback.d.ts index 18504ab7ef9499cfcdad1748bbb21574adb66679..ec7e69fc20c40ab68c19a0b96c57d908974f1f59 100644 --- a/api/@ohos.app.ability.ApplicationStateChangeCallback.d.ts +++ b/api/@ohos.app.ability.ApplicationStateChangeCallback.d.ts @@ -40,9 +40,10 @@ * @StageModelOnly * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class ApplicationStateChangeCallback { +declare class ApplicationStateChangeCallback { /** * Called back when the state of the application changes to foreground. * @@ -95,3 +96,5 @@ export default class ApplicationStateChangeCallback { */ onApplicationBackground(): void; } + +export default ApplicationStateChangeCallback; \ No newline at end of file diff --git a/api/@ohos.app.ability.Configuration.d.ts b/api/@ohos.app.ability.Configuration.d.ts index 257f7e74605092659e1f39066f6ec415206ef23a..5430c59bb46f26103f1f1951e7d424c46334215b 100644 --- a/api/@ohos.app.ability.Configuration.d.ts +++ b/api/@ohos.app.ability.Configuration.d.ts @@ -42,7 +42,8 @@ import ConfigurationConstant from './@ohos.app.ability.ConfigurationConstant'; * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Configuration { /** @@ -67,7 +68,8 @@ export interface Configuration { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ language?: string; @@ -93,7 +95,8 @@ export interface Configuration { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ colorMode?: ConfigurationConstant.ColorMode; @@ -119,7 +122,8 @@ export interface Configuration { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ direction?: ConfigurationConstant.Direction; @@ -145,7 +149,8 @@ export interface Configuration { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ screenDensity?: ConfigurationConstant.ScreenDensity; @@ -162,7 +167,8 @@ export interface Configuration { * @type { ?number } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ displayId?: number; @@ -179,7 +185,8 @@ export interface Configuration { * @type { ?boolean } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ hasPointerDevice?: boolean; @@ -189,7 +196,8 @@ export interface Configuration { * @type { ?string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ fontId?: string; @@ -208,7 +216,8 @@ export interface Configuration { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ fontSizeScale?: number; @@ -218,7 +227,8 @@ export interface Configuration { * @type { ?number } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fontWeightScale?: number; @@ -228,7 +238,8 @@ export interface Configuration { * @type { ?string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ mcc?: string; @@ -238,7 +249,8 @@ export interface Configuration { * @type { ?string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ mnc?: string; } diff --git a/api/@ohos.app.ability.ConfigurationConstant.d.ts b/api/@ohos.app.ability.ConfigurationConstant.d.ts index 54494c948072e1eccc095da27a37b4bbbe83e190..84c4264ac42d270b1d14a52a5a82c875433def78 100644 --- a/api/@ohos.app.ability.ConfigurationConstant.d.ts +++ b/api/@ohos.app.ability.ConfigurationConstant.d.ts @@ -40,7 +40,8 @@ * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace ConfigurationConstant { /** @@ -65,7 +66,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ColorMode { /** @@ -87,7 +89,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_MODE_NOT_SET = -1, @@ -110,7 +113,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_MODE_DARK = 0, @@ -133,7 +137,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_MODE_LIGHT = 1 } @@ -160,7 +165,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum Direction { /** @@ -182,7 +188,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTION_NOT_SET = -1, @@ -205,7 +212,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTION_VERTICAL = 0, @@ -228,7 +236,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTION_HORIZONTAL = 1 } @@ -255,7 +264,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ScreenDensity { /** @@ -277,7 +287,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_NOT_SET = 0, @@ -300,7 +311,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_SDPI = 120, @@ -323,7 +335,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_MDPI = 160, @@ -346,7 +359,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_LDPI = 240, @@ -369,7 +383,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_XLDPI = 320, @@ -392,7 +407,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_XXLDPI = 480, @@ -415,7 +431,8 @@ declare namespace ConfigurationConstant { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREEN_DENSITY_XXXLDPI = 640 } diff --git a/api/@ohos.app.ability.EnvironmentCallback.d.ts b/api/@ohos.app.ability.EnvironmentCallback.d.ts index 7eaea804e905e5eeac25c1362c9b40743843305f..a501cb6845a19e81305eded6777c15e7d44249a6 100644 --- a/api/@ohos.app.ability.EnvironmentCallback.d.ts +++ b/api/@ohos.app.ability.EnvironmentCallback.d.ts @@ -18,8 +18,10 @@ * @kit AbilityKit */ +/*** if arkts 1.1 */ import AbilityConstant from './@ohos.app.ability.AbilityConstant'; import { Configuration } from './@ohos.app.ability.Configuration'; +/*** endif */ /** * The environment callback. @@ -32,9 +34,10 @@ import { Configuration } from './@ohos.app.ability.Configuration'; * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class EnvironmentCallback { +declare class EnvironmentCallback { /** * Called when the system configuration is updated. * @@ -75,3 +78,4 @@ export default class EnvironmentCallback { */ onMemoryLevel(level: AbilityConstant.MemoryLevel): void; } +export default EnvironmentCallback; \ No newline at end of file diff --git a/api/@ohos.app.ability.ExtensionAbility.d.ts b/api/@ohos.app.ability.ExtensionAbility.d.ts index d77b273b9166badf151406c64d83e2f710d668a3..8540140a3177ac0fe72821a5ebd625125265852d 100644 --- a/api/@ohos.app.ability.ExtensionAbility.d.ts +++ b/api/@ohos.app.ability.ExtensionAbility.d.ts @@ -35,6 +35,7 @@ import Ability from './@ohos.app.ability.Ability'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export default class ExtensionAbility extends Ability {} diff --git a/api/@ohos.app.ability.InsightIntentContext.d.ts b/api/@ohos.app.ability.InsightIntentContext.d.ts index 94f9f0d66d069255b252ebf8f9a1e9bdc4759c4b..5f8e20ab4d2162703d7ac9947882571b89488be8 100644 --- a/api/@ohos.app.ability.InsightIntentContext.d.ts +++ b/api/@ohos.app.ability.InsightIntentContext.d.ts @@ -27,9 +27,10 @@ import type Want from './@ohos.app.ability.Want'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class InsightIntentContext { +declare class InsightIntentContext { /** * Starts a new ability. * This interface only allows you to start abilities within the same bundle and specify the bundleName. @@ -56,7 +57,8 @@ export default class InsightIntentContext { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ startAbility(want: Want, callback: AsyncCallback): void; @@ -86,7 +88,10 @@ export default class InsightIntentContext { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ startAbility(want: Want): Promise; } + +export default InsightIntentContext; \ No newline at end of file diff --git a/api/@ohos.app.ability.InsightIntentExecutor.d.ts b/api/@ohos.app.ability.InsightIntentExecutor.d.ts index 69a71decc5906491b95e21bd8d0456cdfcacd261..c96abb0f0aba40a2000adcc5b70da206e728d947 100644 --- a/api/@ohos.app.ability.InsightIntentExecutor.d.ts +++ b/api/@ohos.app.ability.InsightIntentExecutor.d.ts @@ -29,9 +29,10 @@ import type UIExtensionContentSession from './@ohos.app.ability.UIExtensionConte * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class InsightIntentExecutor { +declare class InsightIntentExecutor { /** * Indicates context of insight intent. * @@ -39,7 +40,8 @@ export default class InsightIntentExecutor { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ context: InsightIntentContext; @@ -53,7 +55,8 @@ export default class InsightIntentExecutor { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onExecuteInUIAbilityForegroundMode(name: string, param: Record, pageLoader: window.WindowStage): insightIntent.ExecuteResult | Promise; @@ -67,7 +70,8 @@ export default class InsightIntentExecutor { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onExecuteInUIAbilityBackgroundMode(name: string, param: Record): insightIntent.ExecuteResult | Promise; @@ -81,7 +85,8 @@ export default class InsightIntentExecutor { * @returns { insightIntent.ExecuteResult | Promise } The result of insight intent execution, support promise. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onExecuteInUIExtensionAbility(name: string, param: Record, pageLoader: UIExtensionContentSession): insightIntent.ExecuteResult | Promise; @@ -94,8 +99,11 @@ export default class InsightIntentExecutor { * @returns { insightIntent.ExecuteResult | Promise } The result of insight intent execution, support promise. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onExecuteInServiceExtensionAbility(name: string, param: Record): insightIntent.ExecuteResult | Promise; } + +export default InsightIntentExecutor; \ No newline at end of file diff --git a/api/@ohos.app.ability.OpenLinkOptions.d.ts b/api/@ohos.app.ability.OpenLinkOptions.d.ts index e93d8ff2a737a88ceb1db1895ebff86469ef7dff..63873b4f2c5d3eedc833a89db84a6641e0c077fe 100644 --- a/api/@ohos.app.ability.OpenLinkOptions.d.ts +++ b/api/@ohos.app.ability.OpenLinkOptions.d.ts @@ -25,7 +25,8 @@ * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export default interface OpenLinkOptions { /** @@ -36,7 +37,8 @@ export default interface OpenLinkOptions { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ appLinkingOnly?: boolean; @@ -47,7 +49,8 @@ export default interface OpenLinkOptions { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Record; } diff --git a/api/@ohos.app.ability.ServiceExtensionAbility.d.ts b/api/@ohos.app.ability.ServiceExtensionAbility.d.ts index 5dd0eb9f5cddabc1373a2889156000043998548f..d165ae8b8da9904df45b1b82d62ee9db5197b442 100644 --- a/api/@ohos.app.ability.ServiceExtensionAbility.d.ts +++ b/api/@ohos.app.ability.ServiceExtensionAbility.d.ts @@ -29,9 +29,10 @@ import { Configuration } from './@ohos.app.ability.Configuration'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class ServiceExtensionAbility { +declare class ServiceExtensionAbility { /** * Indicates service extension ability context. * @@ -39,7 +40,8 @@ export default class ServiceExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ context: ServiceExtensionContext; @@ -50,7 +52,8 @@ export default class ServiceExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onCreate(want: Want): void; @@ -60,7 +63,8 @@ export default class ServiceExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onDestroy(): void; @@ -74,7 +78,8 @@ export default class ServiceExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onRequest(want: Want, startId: number): void; @@ -91,6 +96,32 @@ export default class ServiceExtensionAbility { */ onConnect(want: Want): rpc.RemoteObject | Promise; + /** + * Called back when a service extension is first connected to an ability. + * + * @param { Want } want - Indicates connection information about the Service ability. + * @returns { rpc.RemoteObject } A RemoteObject for communication between the client and server. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + onConnect(want: Want): rpc.RemoteObject; + + /** + * Called back when a service extension is first connected to an ability. + * + * @param { Want } want - Indicates connection information about the Service ability. + * @returns { Promise } A RemoteObject for communication between the client and server. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + onConnectAsync(want: Want): Promise; + /** * Called back when all abilities connected to a service extension are disconnected. * @@ -103,6 +134,32 @@ export default class ServiceExtensionAbility { */ onDisconnect(want: Want): void | Promise; + /** + * Called back when all abilities connected to a service extension are disconnected. + * + * @param { Want } want - Indicates disconnection information about the service extension. + * @returns { void } the promise returned by the function. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + onDisconnect(want: Want): void; + + /** + * Called back when all abilities connected to a service extension are disconnected. + * + * @param { Want } want - Indicates disconnection information about the service extension. + * @returns { Promise } the promise returned by the function. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + onDisconnectAsync(want: Want): Promise; + /** * Called when a new client attempts to connect to a service extension after all previous client connections to it * are disconnected. @@ -122,7 +179,8 @@ export default class ServiceExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onConfigurationUpdate(newConfig: Configuration): void; @@ -135,7 +193,10 @@ export default class ServiceExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onDump(params: Array): Array; } + +export default ServiceExtensionAbility; \ No newline at end of file diff --git a/api/@ohos.app.ability.StartOptions.d.ts b/api/@ohos.app.ability.StartOptions.d.ts index 08ce48efb8ecf69e1d41ff14983a82cc80dfe99c..d46757642e3070b356d7b8d0f23520beded6b0bb 100644 --- a/api/@ohos.app.ability.StartOptions.d.ts +++ b/api/@ohos.app.ability.StartOptions.d.ts @@ -35,7 +35,8 @@ import bundleManager from './@ohos.bundle.bundleManager'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export default class StartOptions { /** @@ -47,7 +48,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ windowMode?: number; @@ -66,7 +68,8 @@ export default class StartOptions { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ displayId?: number; @@ -76,7 +79,8 @@ export default class StartOptions { * @type { ?boolean } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ withAnimation?: boolean; @@ -86,7 +90,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ windowLeft?: number; @@ -96,7 +101,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ windowTop?: number; @@ -106,7 +112,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ windowWidth?: number; @@ -116,7 +123,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ windowHeight?: number; @@ -127,7 +135,8 @@ export default class StartOptions { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ windowFocused?: boolean; @@ -139,7 +148,8 @@ export default class StartOptions { * @type { ?contextConstant.ProcessMode } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ processMode?: contextConstant.ProcessMode; @@ -151,7 +161,8 @@ export default class StartOptions { * @type { ?contextConstant.StartupVisibility } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ startupVisibility?: contextConstant.StartupVisibility; @@ -161,7 +172,8 @@ export default class StartOptions { * @type { ?image.PixelMap } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ startWindowIcon?: image.PixelMap; @@ -171,7 +183,8 @@ export default class StartOptions { * @type { ?string } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ startWindowBackgroundColor?: string; @@ -181,7 +194,8 @@ export default class StartOptions { * @type { ?Array } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ supportWindowModes?: Array; @@ -191,7 +205,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapAbility.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ minWindowWidth?: number; @@ -201,7 +216,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapAbility.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ minWindowHeight?: number; @@ -211,7 +227,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapAbility.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxWindowWidth?: number; @@ -221,7 +238,8 @@ export default class StartOptions { * @type { ?number } * @syscap SystemCapAbility.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ maxWindowHeight?: number; } \ No newline at end of file diff --git a/api/@ohos.app.ability.UIAbility.d.ts b/api/@ohos.app.ability.UIAbility.d.ts index bf815f511216219a1da46b8e04a24fbdb418de85..443b6a9f5a17505f98727f4b42ee936d20a64eb4 100644 --- a/api/@ohos.app.ability.UIAbility.d.ts +++ b/api/@ohos.app.ability.UIAbility.d.ts @@ -18,10 +18,10 @@ * @kit AbilityKit */ +import rpc from './@ohos.rpc'; import Ability from './@ohos.app.ability.Ability'; import AbilityConstant from './@ohos.app.ability.AbilityConstant'; import UIAbilityContext from './application/UIAbilityContext'; -import rpc from './@ohos.rpc'; import Want from './@ohos.app.ability.Want'; import window from './@ohos.window'; @@ -45,6 +45,19 @@ export interface OnReleaseCallback { (msg: string): void; } +/** + * The prototype of the listener function interface registered by the Caller. + * Defines the callback of OnRelease. + * + * @typedef OnReleaseCallback + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @param { string } msg - The notification event string listened to by the OnRelease. + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ +export type OnReleaseCallback = (msg: string)=> void; + /** * The prototype of the listener function interface registered by the Caller. * @@ -65,6 +78,18 @@ export interface OnRemoteStateChangeCallback { (msg: string): void; } +/** + * The prototype of the listener function interface registered by the Caller. + * Defines the callback of OnRemoteStateChange. + * @param { string } msg - The notification event string listened to by the OnRemoteStateChange. + * @typedef OnRemoteStateChangeCallback + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ +export type OnRemoteStateChangeCallback = (msg: string)=> void; + /** * The prototype of the message listener function interface registered by the Callee. * @@ -86,13 +111,27 @@ export interface CalleeCallback { (indata: rpc.MessageSequence): rpc.Parcelable; } +/** + * The prototype of the message listener function interface registered by the Callee. + * Defines the callback of Callee. + * @param { rpc.MessageSequence } indata - Notification indata to the callee. + * @returns { rpc.Parcelable } Returns the callee's notification result indata. + * @typedef CalleeCallback + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ +export type CalleeCallback = (indata: rpc.MessageSequence)=> rpc.Parcelable; + /** * The interface of a Caller. * * @interface Caller * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Caller { /** @@ -108,7 +147,8 @@ export interface Caller { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ call(method: string, data: rpc.Parcelable): Promise; @@ -136,7 +176,8 @@ export interface Caller { * @throws { BusinessError } 16200002 - The callee does not exist. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ release(): void; @@ -149,7 +190,8 @@ export interface Caller { * @throws { BusinessError } 16200001 - Caller released. The caller has been released. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onRelease(callback: OnReleaseCallback): void; @@ -212,7 +254,8 @@ export interface Caller { * @interface Callee * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Callee { /** @@ -270,9 +313,10 @@ export interface Callee { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class UIAbility extends Ability { +declare class UIAbility extends Ability { /** * Indicates configuration information about an ability context. * @@ -298,7 +342,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ context: UIAbilityContext; @@ -317,7 +362,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ launchWant: Want; @@ -336,7 +382,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ lastRequestWant: Want; @@ -346,7 +393,8 @@ export default class UIAbility extends Ability { * @type { Callee } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ callee: Callee; @@ -378,7 +426,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void; @@ -407,7 +456,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowStageCreate(windowStage: window.WindowStage): void; @@ -418,7 +468,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowStageWillDestroy(windowStage: window.WindowStage): void; @@ -444,7 +495,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowStageDestroy(): void; @@ -463,7 +515,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowStageRestore(windowStage: window.WindowStage): void; @@ -486,9 +539,6 @@ export default class UIAbility extends Ability { */ /** * Called back before an ability is destroyed. - * After the onDestroy() lifecycle callback is executed, the application may exit. Consequently, - * the asynchronous function (for example, asynchronously writing data to the database) in onDestroy() may fail to be executed. - * You can use the asynchronous lifecycle to ensure that the subsequent lifecycle continues only after the asynchronous function in onDestroy() finishes the execution. * * @returns { void | Promise } the promise returned by the function. * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore @@ -499,6 +549,40 @@ export default class UIAbility extends Ability { */ onDestroy(): void | Promise; + /** + * Called back before an ability is destroyed. + * After the onDestroy() lifecycle callback is executed, the application may exit. Consequently, + * the asynchronous function (for example, asynchronously writing data to the database) in onDestroy() may fail to be executed. + * You can use the asynchronous lifecycle to ensure that the subsequent lifecycle continues only after the + * asynchronous function in onDestroy() finishes the execution. + * + * @returns { void } the promise returned by the function. + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDestroy(): void; + + /** + * Called back before an ability is destroyed. + * After the onDestroy() lifecycle callback is executed, the application may exit. Consequently, + * the asynchronous function (for example, asynchronously writing data to the database) in onDestroy() may fail to be executed. + * You can use the asynchronous lifecycle to ensure that the subsequent lifecycle continues only after the + * asynchronous function in onDestroy() finishes the execution. + * + * @returns { Promise } the promise returned by the function. + * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onDestroyAsync(): Promise; + /** * Called back when the state of an ability changes to foreground. * @@ -521,7 +605,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onForeground(): void; @@ -567,7 +652,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onBackground(): void; @@ -645,8 +731,8 @@ export default class UIAbility extends Ability { * @since 10 */ /** - * Called when a UIAbility instance that has undergone the following states is started again: - * started in the foreground, running in the foreground, and switched to the background. + * Called when the launch mode of an ability is set to singleton. + * This happens when you re-launch an ability that has been at the top of the ability stack. * * @param { Want } want - Indicates the want info of ability. * @param { AbilityConstant.LaunchParam } launchParam - Indicates the launch parameters. @@ -654,7 +740,8 @@ export default class UIAbility extends Ability { * @stagemodelonly * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void; @@ -677,7 +764,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onDump(params: Array): Array; @@ -721,7 +809,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onShare(wantParam: Record): void; @@ -780,7 +869,8 @@ export default class UIAbility extends Ability { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onBackPressed(): boolean; @@ -795,3 +885,5 @@ export default class UIAbility extends Ability { */ onCollaborate(wantParam: Record): AbilityConstant.CollaborateResult; } + +export default UIAbility; \ No newline at end of file diff --git a/api/@ohos.app.ability.UIExtensionAbility.d.ts b/api/@ohos.app.ability.UIExtensionAbility.d.ts index 48edf419bdbe65a7e60b7b32d30647a2df0a6399..6b1b954bcb05915910be3a341ab7af1b6ccadc8e 100755 --- a/api/@ohos.app.ability.UIExtensionAbility.d.ts +++ b/api/@ohos.app.ability.UIExtensionAbility.d.ts @@ -30,16 +30,18 @@ import type Want from './@ohos.app.ability.Want'; * @extends ExtensionAbility * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class UIExtensionAbility extends ExtensionAbility { +declare class UIExtensionAbility extends ExtensionAbility { /** * Indicates configuration information about an UI extension ability context. * * @type { UIExtensionContext } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ context: UIExtensionContext; @@ -56,7 +58,8 @@ export default class UIExtensionAbility extends ExtensionAbility { * @param { AbilityConstant.LaunchParam } launchParam - Indicates the LaunchParam information about UIExtensionAbility. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onCreate(launchParam: AbilityConstant.LaunchParam): void; @@ -67,7 +70,8 @@ export default class UIExtensionAbility extends ExtensionAbility { * @param { UIExtensionContentSession } session - Indicates the session of the UI extension page. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ onSessionCreate(want: Want, session: UIExtensionContentSession): void; @@ -77,7 +81,8 @@ export default class UIExtensionAbility extends ExtensionAbility { * @param { UIExtensionContentSession } session - Indicates the session of the UI extension page. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ onSessionDestroy(session: UIExtensionContentSession): void; @@ -86,7 +91,8 @@ export default class UIExtensionAbility extends ExtensionAbility { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ onForeground(): void; @@ -95,7 +101,8 @@ export default class UIExtensionAbility extends ExtensionAbility { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ onBackground(): void; @@ -108,4 +115,28 @@ export default class UIExtensionAbility extends ExtensionAbility { * @since 10 */ onDestroy(): void | Promise; + + /** + * Called back before an UI extension is destroyed. + * + * @returns { void } the promise returned by the function. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @StageModelOnly + * @since 20 + * @arkts 1.2 + */ + onDestroy(): void; + + /** + * Called back before an UI extension is destroyed. + * + * @returns { Promise } the promise returned by the function. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @StageModelOnly + * @since 20 + * @arkts 1.2 + */ + onDestroyAsync(): Promise; } + +export default UIExtensionAbility; \ No newline at end of file diff --git a/api/@ohos.app.ability.UIExtensionContentSession.d.ts b/api/@ohos.app.ability.UIExtensionContentSession.d.ts index 254253c3496053747a4c3462ea031ef591053399..c7d739ee30364b0d71635375528a69f339e49f41 100644 --- a/api/@ohos.app.ability.UIExtensionContentSession.d.ts +++ b/api/@ohos.app.ability.UIExtensionContentSession.d.ts @@ -17,23 +17,29 @@ * @file * @kit AbilityKit */ - +/*** if arkts 1.1 */ import type { AbilityResult } from './ability/abilityResult'; +/*** endif */ import type AbilityStartCallback from './application/AbilityStartCallback'; import type { AsyncCallback } from './@ohos.base'; import type Want from './@ohos.app.ability.Want'; import type StartOptions from './@ohos.app.ability.StartOptions'; import type uiExtensionHost from './@ohos.uiExtensionHost'; import type uiExtension from './@ohos.arkui.uiExtension'; +/*** if arkts 1.2 */ +import { AbilityResult } from './ability/abilityResult'; +import { LocalStorage } from './@ohos.arkui.stateManagement'; +/*** endif */ /** * class of ui extension content session. * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class UIExtensionContentSession { +declare class UIExtensionContentSession { /** * Send data from an ui extension to an ui extension component. * @@ -58,7 +64,8 @@ export default class UIExtensionContentSession { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ sendData(data: Record): void; @@ -73,7 +80,8 @@ export default class UIExtensionContentSession { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ setReceiveDataCallback(callback: (data: Record) => void): void; @@ -88,7 +96,8 @@ export default class UIExtensionContentSession { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ setReceiveDataForResultCallback(callback: (data: Record) => Record): void; @@ -102,7 +111,8 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ loadContent(path: string, storage?: LocalStorage): void; @@ -452,7 +462,8 @@ export default class UIExtensionContentSession { * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ terminateSelf(callback: AsyncCallback): void; @@ -462,7 +473,8 @@ export default class UIExtensionContentSession { * @returns { Promise } The promise returned by the function. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ terminateSelf(): Promise; @@ -475,7 +487,8 @@ export default class UIExtensionContentSession { * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback): void; @@ -488,7 +501,8 @@ export default class UIExtensionContentSession { * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ terminateSelfWithResult(parameter: AbilityResult): Promise; @@ -503,7 +517,8 @@ export default class UIExtensionContentSession { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ setWindowBackgroundColor(color: string): void; @@ -626,7 +641,8 @@ export default class UIExtensionContentSession { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getUIExtensionHostWindowProxy(): uiExtensionHost.UIExtensionHostWindowProxy; @@ -637,7 +653,10 @@ export default class UIExtensionContentSession { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getUIExtensionWindowProxy(): uiExtension.WindowProxy; } + +export default UIExtensionContentSession; \ No newline at end of file diff --git a/api/@ohos.app.ability.UIServiceExtensionAbility.d.ts b/api/@ohos.app.ability.UIServiceExtensionAbility.d.ts index 1371b622ce41701926527457f2319d57b8d3e5f2..77761bfbbb0c54013da6ba704178a2fae50ea126 100644 --- a/api/@ohos.app.ability.UIServiceExtensionAbility.d.ts +++ b/api/@ohos.app.ability.UIServiceExtensionAbility.d.ts @@ -137,4 +137,4 @@ export default class UIServiceExtensionAbility extends ExtensionAbility { * @since 14 */ onDestroy(): void; -} +} \ No newline at end of file diff --git a/api/@ohos.app.ability.UserAuthExtensionAbility.d.ts b/api/@ohos.app.ability.UserAuthExtensionAbility.d.ts index 7a8e808c03da3a0ac350f84532914d8a63e80bd2..0174219fb86c12a7b7e1f1f53dfc84802bc5b4ac 100644 --- a/api/@ohos.app.ability.UserAuthExtensionAbility.d.ts +++ b/api/@ohos.app.ability.UserAuthExtensionAbility.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2023 Huawei Device Co., Ltd. + * Copyright (c) 2023-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 @@ -16,6 +16,7 @@ /** * @file * @kit UserAuthenticationKit + * @arkts 1.1&1.2 */ import UIExtensionAbility from './@ohos.app.ability.UIExtensionAbility'; @@ -27,7 +28,7 @@ import UIExtensionAbility from './@ohos.app.ability.UIExtensionAbility'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi Hide this for inner system use. * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} */ export default class UserAuthExtensionAbility extends UIExtensionAbility { } \ No newline at end of file diff --git a/api/@ohos.app.ability.Want.d.ts b/api/@ohos.app.ability.Want.d.ts index 68dead0b67d2e4b51148aace2cfc6160d6f3aa5c..cae1e4498098cd4ceec10c444cb3794ca3452df9 100644 --- a/api/@ohos.app.ability.Want.d.ts +++ b/api/@ohos.app.ability.Want.d.ts @@ -37,7 +37,8 @@ * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export default class Want { /** @@ -61,7 +62,8 @@ export default class Want { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName?: string; @@ -86,7 +88,8 @@ export default class Want { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ abilityName?: string; @@ -103,7 +106,8 @@ export default class Want { * @type { ?string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ deviceId?: string; @@ -120,7 +124,8 @@ export default class Want { * @type { ?string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ uri?: string; @@ -146,7 +151,8 @@ export default class Want { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ type?: string; @@ -163,7 +169,8 @@ export default class Want { * @type { ?number } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ flags?: number; @@ -180,7 +187,8 @@ export default class Want { * @type { ?string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ action?: string; @@ -206,7 +214,8 @@ export default class Want { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Record; @@ -223,7 +232,8 @@ export default class Want { * @type { ?Array } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ entities?: Array; @@ -248,7 +258,8 @@ export default class Want { * @syscap SystemCapability.Ability.AbilityBase * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName?: string; @@ -259,7 +270,8 @@ export default class Want { * @readonly * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly fds?: Record; } diff --git a/api/@ohos.app.ability.abilityDelegatorRegistry.d.ts b/api/@ohos.app.ability.abilityDelegatorRegistry.d.ts index 73ebf3af72caada227f12566b953cf74d6ee5c2c..73a423a81ad9fe7ff020345f4f94db6a515bee2b 100644 --- a/api/@ohos.app.ability.abilityDelegatorRegistry.d.ts +++ b/api/@ohos.app.ability.abilityDelegatorRegistry.d.ts @@ -23,7 +23,6 @@ import { AbilityDelegatorArgs as _AbilityDelegatorArgs } from './application/abi import { AbilityMonitor as _AbilityMonitor } from './application/AbilityMonitor'; import { AbilityStageMonitor as _AbilityStageMonitor } from './application/AbilityStageMonitor'; import { ShellCmdResult as _ShellCmdResult } from './application/shellCmdResult'; - /** * A global register used to store the AbilityDelegator and AbilityDelegatorArgs objects registered * during application startup. @@ -49,7 +48,8 @@ import { ShellCmdResult as _ShellCmdResult } from './application/shellCmdResult' * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace abilityDelegatorRegistry { /** @@ -78,6 +78,18 @@ declare namespace abilityDelegatorRegistry { */ function getAbilityDelegator(): AbilityDelegator; + /** + * Get the AbilityDelegator object of the application. + * + * @returns { AbilityDelegator } Return the AbilityDelegator object initialized when the application is started. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function getAbilityDelegator(): AbilityDelegator; + /** * Get unit test arguments stored in the AbilityDelegatorArgs object. * @@ -104,6 +116,18 @@ declare namespace abilityDelegatorRegistry { */ function getArguments(): AbilityDelegatorArgs; + /** + * Get unit test arguments stored in the AbilityDelegatorArgs object. + * + * @returns { AbilityDelegatorArgs } Return the previously registered AbilityDelegatorArgs object. + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function getArguments(): AbilityDelegatorArgs; + /** * Describes all lifecycle states of an ability. * @@ -126,7 +150,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum AbilityLifecycleState { /** @@ -148,7 +173,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNINITIALIZED, @@ -171,7 +197,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CREATE, @@ -194,7 +221,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FOREGROUND, @@ -217,7 +245,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND, @@ -240,7 +269,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DESTROY } @@ -265,7 +295,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityDelegator = _AbilityDelegator; @@ -289,7 +320,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityDelegatorArgs = _AbilityDelegatorArgs; @@ -316,7 +348,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityMonitor = _AbilityMonitor; @@ -332,7 +365,8 @@ declare namespace abilityDelegatorRegistry { * @typedef { _ShellCmdResult } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ShellCmdResult = _ShellCmdResult; @@ -344,7 +378,8 @@ declare namespace abilityDelegatorRegistry { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityStageMonitor = _AbilityStageMonitor; } diff --git a/api/@ohos.app.ability.abilityManager.d.ts b/api/@ohos.app.ability.abilityManager.d.ts index 979e15841365af2cd1e085d8f3fb0836277953d1..44dedd35a32aae1d06529766e9ae4866b15a7499 100644 --- a/api/@ohos.app.ability.abilityManager.d.ts +++ b/api/@ohos.app.ability.abilityManager.d.ts @@ -18,22 +18,29 @@ * @kit AbilityKit */ -import { AbilityResult } from './ability/abilityResult'; import { AsyncCallback } from './@ohos.base'; -import { Configuration } from './@ohos.app.ability.Configuration'; -import Context from './application/Context'; +import { ElementName } from './bundleManager/ElementName'; import { AbilityRunningInfo as _AbilityRunningInfo } from './application/AbilityRunningInfo'; import { ExtensionRunningInfo as _ExtensionRunningInfo } from './application/ExtensionRunningInfo'; -import { ElementName } from './bundleManager/ElementName'; +/*** if arkts 1.1 */ +import { AbilityResult } from './ability/abilityResult'; +import { Configuration } from './@ohos.app.ability.Configuration'; +import Context from './application/Context'; import * as _AbilityForegroundStateObserver from './application/AbilityForegroundStateObserver'; import * as _AbilityStateData from './application/AbilityStateData'; +/*** endif */ +/*** if arkts 1.2 */ +import _AbilityForegroundStateObserver from './application/AbilityForegroundStateObserver'; +import _AbilityStateData from './application/AbilityStateData'; +/*** endif */ /** * The class of an ability manager. * * @namespace abilityManager * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace abilityManager { /** @@ -41,14 +48,16 @@ declare namespace abilityManager { * * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum AbilityState { /** * Ability is initialized. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ INITIAL = 0, @@ -56,7 +65,8 @@ declare namespace abilityManager { * Ability is in the state of getting focus. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS = 2, @@ -64,7 +74,8 @@ declare namespace abilityManager { * Ability is in the foreground state. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ FOREGROUND = 9, @@ -72,7 +83,8 @@ declare namespace abilityManager { * Ability is in the background state. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND = 10, @@ -80,7 +92,8 @@ declare namespace abilityManager { * Ability is in the process of scheduling at the foreground. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ FOREGROUNDING = 11, @@ -88,7 +101,8 @@ declare namespace abilityManager { * Ability is in the process of scheduling in the background. * * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUNDING = 12 } @@ -100,7 +114,8 @@ declare namespace abilityManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum UserStatus { /** @@ -109,7 +124,8 @@ declare namespace abilityManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSERT_TERMINATE = 0, @@ -119,7 +135,8 @@ declare namespace abilityManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSERT_CONTINUE = 1, @@ -129,7 +146,8 @@ declare namespace abilityManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSERT_RETRY = 2 } @@ -241,7 +259,8 @@ declare namespace abilityManager { * @returns { Promise> } Returns the array of AbilityRunningInfo. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAbilityRunningInfos(): Promise>; @@ -258,7 +277,8 @@ declare namespace abilityManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAbilityRunningInfos(callback: AsyncCallback>): void; @@ -305,7 +325,8 @@ declare namespace abilityManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTopAbility(): Promise; @@ -319,7 +340,8 @@ declare namespace abilityManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTopAbility(callback: AsyncCallback): void; @@ -387,7 +409,6 @@ declare namespace abilityManager { * @param { number } requestCode - Request code defined by the user. * @param { AsyncCallback } callback - The callback of the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000050 - Internal error. @@ -404,7 +425,6 @@ declare namespace abilityManager { * @param { number } requestCode - Request code defined by the user. * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system application. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 16000050 - Internal error. @@ -441,7 +461,8 @@ declare namespace abilityManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getForegroundUIAbilities(): Promise>; @@ -520,7 +541,8 @@ declare namespace abilityManager { * @typedef { _AbilityRunningInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityRunningInfo = _AbilityRunningInfo; @@ -534,13 +556,24 @@ declare namespace abilityManager { */ export type AbilityStateData = _AbilityStateData.default; + /** + * The ability state data. + * + * @typedef { _AbilityStateData } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type AbilityStateData = _AbilityStateData; /** * The class of an extension running information. * * @typedef { _ExtensionRunningInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ExtensionRunningInfo = _ExtensionRunningInfo; @@ -553,6 +586,17 @@ declare namespace abilityManager { * @since 11 */ export type AbilityForegroundStateObserver = _AbilityForegroundStateObserver.default; + + /** + * The ability foreground state observer. + * + * @typedef { _AbilityForegroundStateObserver } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type AbilityForegroundStateObserver = _AbilityForegroundStateObserver; } export default abilityManager; diff --git a/api/@ohos.app.ability.appManager.d.ts b/api/@ohos.app.ability.appManager.d.ts index 026423f30843dc3efd49dd66342aff6523f472e4..9bb352c39d27bbec2de17734b34200bd83d80d3a 100644 --- a/api/@ohos.app.ability.appManager.d.ts +++ b/api/@ohos.app.ability.appManager.d.ts @@ -19,17 +19,24 @@ */ import { AsyncCallback } from './@ohos.base'; +import { ProcessInformation as _ProcessInformation } from './application/ProcessInformation'; +import bundleManager from './@ohos.bundle.bundleManager'; +import { RunningMultiAppInfo as _RunningMultiAppInfo } from './application/RunningMultiAppInfo'; +/*** if arkts 1.1 */ import * as _ApplicationStateObserver from './application/ApplicationStateObserver'; import type * as _AppForegroundStateObserver from './application/AppForegroundStateObserver'; import * as _AbilityStateData from './application/AbilityStateData'; import * as _AppStateData from './application/AppStateData'; import type * as _ProcessData from './application/ProcessData'; -import { ProcessInformation as _ProcessInformation } from './application/ProcessInformation'; import * as _AbilityFirstFrameStateObserver from './application/AbilityFirstFrameStateObserver'; import * as _AbilityFirstFrameStateData from './application/AbilityFirstFrameStateData'; -import bundleManager from './@ohos.bundle.bundleManager'; -import { RunningMultiAppInfo as _RunningMultiAppInfo } from './application/RunningMultiAppInfo'; - +/*** endif */ +/*** if arkts 1.2 */ +import _ApplicationStateObserver from './application/ApplicationStateObserver'; +import _AbilityStateData from './application/AbilityStateData'; +import _AppStateData from './application/AppStateData'; +import _ProcessData from './application/ProcessData'; +/*** endif */ /** * This module provides the function of app manager service. * @@ -43,7 +50,8 @@ import { RunningMultiAppInfo as _RunningMultiAppInfo } from './application/Runni * @namespace appManager * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace appManager { /** @@ -52,7 +60,8 @@ declare namespace appManager { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ApplicationState { /** @@ -60,7 +69,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_CREATE, @@ -69,7 +79,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_FOREGROUND, @@ -78,7 +89,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_ACTIVE, @@ -87,7 +99,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_BACKGROUND, @@ -96,7 +109,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_DESTROY } @@ -114,7 +128,8 @@ declare namespace appManager { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ProcessState { /** @@ -128,7 +143,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_CREATE, @@ -143,7 +159,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_FOREGROUND, @@ -158,7 +175,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_ACTIVE, @@ -173,7 +191,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_BACKGROUND, @@ -188,7 +207,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_DESTROY } @@ -200,7 +220,8 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PreloadMode { /** @@ -209,7 +230,8 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PRESS_DOWN } @@ -219,7 +241,8 @@ declare namespace appManager { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum KeepAliveAppType { /** @@ -227,7 +250,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ ALL = 0, @@ -236,7 +260,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ THIRD_PARTY = 1, @@ -245,7 +270,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM = 2 } @@ -255,7 +281,8 @@ declare namespace appManager { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum KeepAliveSetter { /** @@ -263,7 +290,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM = 0, @@ -272,7 +300,8 @@ declare namespace appManager { * * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ USER = 1 } @@ -283,7 +312,8 @@ declare namespace appManager { * @typedef KeepAliveBundleInfo * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface KeepAliveBundleInfo { /** @@ -292,7 +322,8 @@ declare namespace appManager { * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -302,7 +333,8 @@ declare namespace appManager { * @type { KeepAliveAppType } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ type: KeepAliveAppType; @@ -312,7 +344,8 @@ declare namespace appManager { * @type { KeepAliveSetter } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ setter: KeepAliveSetter; } @@ -463,7 +496,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getForegroundApplications(callback: AsyncCallback>): void; @@ -477,7 +511,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getForegroundApplications(): Promise>; @@ -512,7 +547,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function killProcessWithAccount(bundleName: string, accountId: number): Promise; @@ -532,7 +568,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function killProcessWithAccount(bundleName: string, accountId: number, clearPageStack: boolean, appIndex?: number): Promise; @@ -568,7 +605,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCallback): void; @@ -591,7 +629,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function isRunningInStabilityTest(callback: AsyncCallback): void; @@ -610,7 +649,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function isRunningInStabilityTest(): Promise; @@ -642,7 +682,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function killProcessesByBundleName(bundleName: string): Promise; @@ -658,7 +699,8 @@ declare namespace appManager { * @throws { BusinessError } 401 - If the input parameter is not valid parameter. * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function killProcessesByBundleName(bundleName: string, clearPageStack: boolean, appIndex?: number): Promise; @@ -743,7 +785,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function isRamConstrainedDevice(): Promise; @@ -766,7 +809,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function isRamConstrainedDevice(callback: AsyncCallback): void; @@ -785,7 +829,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAppMemorySize(): Promise; @@ -808,7 +853,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAppMemorySize(callback: AsyncCallback): void; @@ -829,7 +875,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInformation(): Promise>; @@ -846,7 +893,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInformationByBundleType( bundleType: bundleManager.BundleType): Promise>; @@ -872,7 +920,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInformation(callback: AsyncCallback>): void; @@ -890,7 +939,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSharedBundleRunning(bundleName: string, versionCode: number): Promise; @@ -909,7 +959,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSharedBundleRunning(bundleName: string, versionCode: number, callback: AsyncCallback): void; @@ -924,7 +975,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getProcessMemoryByPid(pid: number): Promise; @@ -939,7 +991,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getProcessMemoryByPid(pid: number, callback: AsyncCallback): void; @@ -954,7 +1007,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInfoByBundleName(bundleName: string, callback: AsyncCallback>): void; @@ -970,7 +1024,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInfoByBundleName(bundleName: string, userId: number, callback: AsyncCallback>): void; @@ -985,7 +1040,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInfoByBundleName(bundleName: string): Promise>; @@ -1001,7 +1057,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningProcessInfoByBundleName(bundleName: string, userId: number): Promise>; @@ -1058,7 +1115,8 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function preloadApplication(bundleName: string, userId: number, mode: PreloadMode, appIndex?: number): Promise; @@ -1077,7 +1135,8 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRunningMultiAppInfo(bundleName: string): Promise; @@ -1094,7 +1153,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @throws { BusinessError } 16000073 - The app clone index is invalid. * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function isAppRunning(bundleName: string, appCloneIndex?: number): Promise; @@ -1149,7 +1209,8 @@ declare namespace appManager { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSupportedProcessCachePids(bundleName : string): Promise>; @@ -1173,7 +1234,8 @@ declare namespace appManager { * @throws { BusinessError } 16300010 - The target application is not attached to status bar. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function setKeepAliveForBundle(bundleName: string, userId: number, enable: boolean): Promise; @@ -1192,7 +1254,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getKeepAliveBundles(type: KeepAliveAppType, userId?: number): Promise>; @@ -1210,7 +1273,8 @@ declare namespace appManager { * @throws { BusinessError } 16000050 - Internal error. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function killProcessesInBatch(pids: Array): Promise; @@ -1224,6 +1288,17 @@ declare namespace appManager { */ export type AbilityStateData = _AbilityStateData.default; + /** + * The ability or extension state data. + * + * @typedef { _AbilityStateData } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type AbilityStateData = _AbilityStateData; + /** * The application state data. * @@ -1234,6 +1309,17 @@ declare namespace appManager { */ export type AppStateData = _AppStateData.default; + /** + * The application state data. + * + * @typedef { _AppStateData } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type AppStateData = _AppStateData; + /** * The application state observer. * @@ -1243,6 +1329,16 @@ declare namespace appManager { */ export type ApplicationStateObserver = _ApplicationStateObserver.default; + /** + * The application state observer. + * + * @typedef { _ApplicationStateObserver } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @since 20 + * @arkts 1.2 + */ + export type ApplicationStateObserver = _ApplicationStateObserver; + /** * The application foreground state observer. * @@ -1265,7 +1361,8 @@ declare namespace appManager { * @typedef { _ProcessInformation } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ProcessInformation = _ProcessInformation; @@ -1279,6 +1376,17 @@ declare namespace appManager { */ export type ProcessData = _ProcessData.default; + /** + * The class of a process information. + * + * @typedef { _ProcessData.default } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type ProcessData = _ProcessData; + /** * The ability first frame state observer. * @@ -1305,7 +1413,8 @@ declare namespace appManager { * @typedef { _RunningMultiAppInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type RunningMultiAppInfo = _RunningMultiAppInfo; } diff --git a/api/@ohos.app.ability.application.d.ts b/api/@ohos.app.ability.application.d.ts index c7c1950aed9f2a1e66c59b408b7390cde55cbade..38c7e2113766abe0009fa312d1e9da4d40ded2cb 100644 --- a/api/@ohos.app.ability.application.d.ts +++ b/api/@ohos.app.ability.application.d.ts @@ -28,7 +28,8 @@ import Context from './application/Context'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace application { /** @@ -41,7 +42,8 @@ declare namespace application { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function createModuleContext(context: Context, moduleName: string): Promise; @@ -59,7 +61,8 @@ declare namespace application { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function createModuleContext(context: Context, bundleName: string, moduleName: string): Promise; @@ -76,7 +79,8 @@ declare namespace application { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function createBundleContext(context: Context, bundleName: string): Promise; diff --git a/api/@ohos.app.ability.autoFillManager.d.ts b/api/@ohos.app.ability.autoFillManager.d.ts index b18eefefd3606a8973afdb32f5ae66dde94f22d6..cd5b550806a8cd0ab81c6087f79ff8822cbd53cc 100644 --- a/api/@ohos.app.ability.autoFillManager.d.ts +++ b/api/@ohos.app.ability.autoFillManager.d.ts @@ -317,7 +317,7 @@ declare namespace autoFillManager { * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore * @systemapi * @stagemodelonly - * @since 12 + * @since 11 */ export type AutoFillPopupConfig = _AutoFillPopupConfig.default; diff --git a/api/@ohos.app.ability.common.d.ts b/api/@ohos.app.ability.common.d.ts index cbc729a6678e887d6fd7fdf893b7241af688d5e2..e661a9635c85b4710aca2a666183a79adbab3e4d 100644 --- a/api/@ohos.app.ability.common.d.ts +++ b/api/@ohos.app.ability.common.d.ts @@ -18,6 +18,7 @@ * @kit AbilityKit */ +/*** if arkts 1.1 */ import * as _UIAbilityContext from './application/UIAbilityContext'; import type * as _UIExtensionContext from './application/UIExtensionContext'; import type * as _AutoFillExtensionContext from './application/AutoFillExtensionContext'; @@ -29,10 +30,6 @@ import * as _ExtensionContext from './application/ExtensionContext'; import * as _FormExtensionContext from './application/FormExtensionContext'; import * as _ServiceExtensionContext from './application/ServiceExtensionContext'; import * as _EventHub from './application/EventHub'; -import { PacMap as _PacMap } from './ability/dataAbilityHelper'; -import { AbilityResult as _AbilityResult } from './ability/abilityResult'; -import type _AbilityStartCallback from './application/AbilityStartCallback'; -import { ConnectOptions as _ConnectOptions } from './ability/connectOptions'; import type * as _VpnExtensionContext from './application/VpnExtensionContext'; import type { AutoStartupCallback as _AutoStartupCallback } from './application/AutoStartupCallback'; import type { AutoStartupInfo as _AutoStartupInfo } from './application/AutoStartupInfo'; @@ -42,6 +39,24 @@ import * as _UIServiceExtensionContext from './application/UIServiceExtensionCon import * as _UIServiceProxy from './application/UIServiceProxy'; import * as _UIServiceHostProxy from './application/UIServiceHostProxy'; import * as _UIServiceExtensionConnectCallback from './application/UIServiceExtensionConnectCallback'; +import { PacMap as _PacMap } from './ability/dataAbilityHelper'; +/*** endif */ +/*** if arkts 1.2 */ +import _UIAbilityContext from './application/UIAbilityContext'; +import type _UIExtensionContext from './application/UIExtensionContext'; +import _AbilityStageContext from './application/AbilityStageContext'; +import _ApplicationContext from './application/ApplicationContext'; +import _BaseContext from './application/BaseContext'; +import _Context from './application/Context'; +import _ExtensionContext from './application/ExtensionContext'; +import _FormExtensionContext from './application/FormExtensionContext'; +import _ServiceExtensionContext from './application/ServiceExtensionContext'; +import _EventHub from './application/EventHub'; +import type _VpnExtensionContext from './application/VpnExtensionContext'; +/*** endif */ +import { AbilityResult as _AbilityResult } from './ability/abilityResult'; +import type _AbilityStartCallback from './application/AbilityStartCallback'; +import { ConnectOptions as _ConnectOptions } from './ability/connectOptions'; /** * This module provides application context classes and common data structures. @@ -67,7 +82,8 @@ import * as _UIServiceExtensionConnectCallback from './application/UIServiceExte * @syscap SystemCapability.Ability.AbilityRuntime.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace common { /** @@ -97,6 +113,19 @@ declare namespace common { */ export type UIAbilityContext = _UIAbilityContext.default; + /** + * The context of an ability. It allows access to ability-specific resources. + * + * @typedef { _UIAbilityContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type UIAbilityContext = _UIAbilityContext; + /** * The context of an abilityStage. It allows access to abilityStage-specific resources. * @@ -124,6 +153,19 @@ declare namespace common { */ export type AbilityStageContext = _AbilityStageContext.default; + /** + * The context of an abilityStage. It allows access to abilityStage-specific resources. + * + * @typedef { _AbilityStageContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type AbilityStageContext = _AbilityStageContext; + /** * The context of an application. It allows access to application-specific resources. * @@ -151,6 +193,19 @@ declare namespace common { */ export type ApplicationContext = _ApplicationContext.default; + /** + * The context of an application. It allows access to application-specific resources. + * + * @typedef { _ApplicationContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type ApplicationContext = _ApplicationContext; + /** * The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode. * @@ -178,6 +233,19 @@ declare namespace common { */ export type BaseContext = _BaseContext.default; + /** + * The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode. + * + * @typedef { _BaseContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type BaseContext = _BaseContext; + /** * The base context of an ability or an application. It allows access to * application-specific resources. @@ -208,6 +276,20 @@ declare namespace common { */ export type Context = _Context.default; + /** + * The base context of an ability or an application. It allows access to + * application-specific resources. + * + * @typedef { _Context } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type Context = _Context; + /** * The context of an extension. It allows access to extension-specific resources. * @@ -226,6 +308,18 @@ declare namespace common { */ export type ExtensionContext = _ExtensionContext.default; + /** + * The context of an extension. It allows access to extension-specific resources. + * + * @typedef { _ExtensionContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type ExtensionContext = _ExtensionContext; + /** * The context of form extension. It allows access to * formExtension-specific resources. @@ -246,6 +340,19 @@ declare namespace common { */ export type FormExtensionContext = _FormExtensionContext.default; + /** + * The context of form extension. It allows access to + * formExtension-specific resources. + * + * @typedef { _FormExtensionContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type FormExtensionContext = _FormExtensionContext; + /** * The context of service extension. It allows access to * serviceExtension-specific resources. @@ -258,6 +365,19 @@ declare namespace common { */ export type ServiceExtensionContext = _ServiceExtensionContext.default; + /** + * The context of service extension. It allows access to + * serviceExtension-specific resources. + * + * @typedef { _ServiceExtensionContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + export type ServiceExtensionContext = _ServiceExtensionContext; + /** * The event center of a context, support the subscription and publication of events. * @@ -285,6 +405,19 @@ declare namespace common { */ export type EventHub = _EventHub.default; + /** + * The event center of a context, support the subscription and publication of events. + * + * @typedef { _EventHub } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type EventHub = _EventHub; + /** * Defines a PacMap object for storing a series of values. * @@ -316,7 +449,8 @@ declare namespace common { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityResult = _AbilityResult; @@ -326,7 +460,8 @@ declare namespace common { * @typedef { _ConnectOptions } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ConnectOptions = _ConnectOptions; @@ -341,6 +476,18 @@ declare namespace common { */ export type UIExtensionContext = _UIExtensionContext.default; + /** + * The context of UI extension. It allows access to + * UIExtension-specific resources. + * + * @typedef { _UIExtensionContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + export type UIExtensionContext = _UIExtensionContext; + /** * The context of auto fill extension. It allows access to * AutoFillExtension-specific resources. @@ -360,7 +507,8 @@ declare namespace common { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type AbilityStartCallback = _AbilityStartCallback; @@ -398,6 +546,19 @@ declare namespace common { */ export type VpnExtensionContext = _VpnExtensionContext.default; + /** + * The context of vpn extension. It allows access to + * vpnExtension-specific resources. + * The class of auto startup info. + * + * @typedef { _VpnExtensionContext } + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @stagemodelonly + * @since 20 + * @arkts 1.2 + */ + export type VpnExtensionContext = _VpnExtensionContext; + /** * The context of an embeddable UIAbility. * diff --git a/api/@ohos.app.ability.contextConstant.d.ts b/api/@ohos.app.ability.contextConstant.d.ts index 27b8e2e769787645981b1e7e300810b8f4ca8f67..7742d6253f51337c81304163e7fb0366c4a58c04 100644 --- a/api/@ohos.app.ability.contextConstant.d.ts +++ b/api/@ohos.app.ability.contextConstant.d.ts @@ -33,7 +33,8 @@ * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace contextConstant { /** @@ -51,7 +52,8 @@ declare namespace contextConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum AreaMode { /** @@ -67,7 +69,8 @@ declare namespace contextConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EL1 = 0, @@ -84,7 +87,8 @@ declare namespace contextConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EL2 = 1, @@ -95,7 +99,8 @@ declare namespace contextConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EL3 = 2, @@ -107,7 +112,8 @@ declare namespace contextConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EL4 = 3, @@ -119,7 +125,8 @@ declare namespace contextConstant { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EL5 = 4 } @@ -130,7 +137,8 @@ declare namespace contextConstant { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ProcessMode { /** @@ -139,7 +147,8 @@ declare namespace contextConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NEW_PROCESS_ATTACH_TO_PARENT = 1, @@ -150,7 +159,8 @@ declare namespace contextConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NEW_PROCESS_ATTACH_TO_STATUS_BAR_ITEM = 2, @@ -161,7 +171,8 @@ declare namespace contextConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ATTACH_TO_STATUS_BAR_ITEM = 3 } @@ -172,7 +183,8 @@ declare namespace contextConstant { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum StartupVisibility { /** @@ -180,7 +192,8 @@ declare namespace contextConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ STARTUP_HIDE = 0, @@ -189,7 +202,8 @@ declare namespace contextConstant { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ STARTUP_SHOW = 1 } diff --git a/api/@ohos.app.ability.dialogRequest.d.ts b/api/@ohos.app.ability.dialogRequest.d.ts index 7c7f7f32781a5729457158fd307a699818951acc..464970de30aeae927f6a96e556853d6468fa49dd 100644 --- a/api/@ohos.app.ability.dialogRequest.d.ts +++ b/api/@ohos.app.ability.dialogRequest.d.ts @@ -25,7 +25,8 @@ import Want from './@ohos.app.ability.Want'; * * @namespace dialogRequest * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace dialogRequest { /** diff --git a/api/@ohos.app.ability.errorManager.d.ts b/api/@ohos.app.ability.errorManager.d.ts index ed6e7d309c61ab605384c8b80cf7849f59fa8e10..0cfab9798a447fde33daaec2ed61230422ae6db6 100644 --- a/api/@ohos.app.ability.errorManager.d.ts +++ b/api/@ohos.app.ability.errorManager.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2025 Huawei Device Co., Ltd. + * Copyright (c) 2022-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 @@ -37,15 +37,6 @@ import { LoopObserver as _LoopObserver } from './application/LoopObserver'; * @atomicservice * @since 11 */ -/** - * This module provides the function of error manager. - * - * @namespace errorManager - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ declare namespace errorManager { /** * Register error observer. @@ -72,20 +63,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * Register error observer. - * - * @param { 'error' } type - error. - * @param { ErrorObserver } observer - The error observer. - * @returns { number } Returns the number code of the observer. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16000003 - The specified ID does not exist. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function on(type: 'error', observer: ErrorObserver): number; /** @@ -113,20 +90,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * Unregister error observer. - * - * @param { 'error' } type - error. - * @param { number } observerId - Indicates the number code of the observer. - * @param { AsyncCallback } callback - The callback of off. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16000003 - The specified ID does not exist. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'error', observerId: number, callback: AsyncCallback): void; /** @@ -154,20 +117,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * Unregister error observer. - * - * @param { 'error' } type - error. - * @param { number } observerId - Indicates the number code of the observer. - * @returns { Promise } The promise returned by the function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16000003 - The specified ID does not exist. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'error', observerId: number): Promise; /** @@ -323,21 +272,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * Register loop observer. This function can only by called from main thread, - * and if call this function multiple times, the last - * modification will overwrite the previous one. - * - * @param { 'loopObserver' } type - loopObserver. - * @param { number } timeout - Indicates timeout(ms) value of loop observer. - * @param { LoopObserver } observer - The loop observer. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function on(type: 'loopObserver', timeout: number, observer: LoopObserver): void; /** @@ -351,18 +285,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * Unregister loop observer. This function can only by called from main thread. - * - * @param { 'loopObserver' } type - loopObserver. - * @param { LoopObserver } observer - The loop observer. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'loopObserver', observer?: LoopObserver): void; /** @@ -377,19 +299,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * Register unhandled rejection observer. - * - * @param { 'unhandledRejection' } type - 'unhandledRejection'. - * @param { UnhandledRejectionObserver } observer - The unhandled rejection observer. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16200001 - If the caller is invalid. - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function on(type: 'unhandledRejection', observer: UnhandledRejectionObserver): void; /** @@ -405,20 +314,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * Unregister unhandled rejection observer. - * - * @param { 'unhandledRejection' } type - error. - * @param { UnhandledRejectionObserver } [observer] - the registered observer - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - * 2. Incorrect parameter types; 3. Parameter verification failed. - * @throws { BusinessError } 16200001 - If the caller is invalid. - * @throws { BusinessError } 16300004 - If the observer does not exist - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ function off(type: 'unhandledRejection', observer?: UnhandledRejectionObserver): void; /** @@ -466,15 +361,6 @@ declare namespace errorManager { * @atomicservice * @since 11 */ - /** - * The observer will be called by system when an error occurs. - * - * @typedef { _ErrorObserver.default } - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ export type ErrorObserver = _ErrorObserver.default; /** * The observer will be called when application main thread execute timeout. @@ -484,15 +370,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * The observer will be called when application main thread execute timeout. - * - * @typedef { _LoopObserver } - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ export type LoopObserver = _LoopObserver; /** * The observer will be called by system when an unhandled rejection occurs. @@ -504,17 +381,6 @@ declare namespace errorManager { * @atomicservice * @since 12 */ - /** - * The observer will be called by system when an unhandled rejection occurs. - * - * @typedef { function } - * { Error | any } reason - the reason of the rejection, typically of Error type - * { Promise } promise - the promise that is rejected - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @crossplatform - * @atomicservice - * @since 18 - */ export type UnhandledRejectionObserver = (reason: Error | any, promise: Promise) => void; /** * The observer will be called by system when freeze happens. diff --git a/api/@ohos.app.ability.insightIntent.d.ts b/api/@ohos.app.ability.insightIntent.d.ts index 83d0c8e1b8aa55d5503018d2e6b7a38f3609d909..4fee2d33202c04e4cc5f3554f5edb8ac631e94fe 100644 --- a/api/@ohos.app.ability.insightIntent.d.ts +++ b/api/@ohos.app.ability.insightIntent.d.ts @@ -28,7 +28,8 @@ import type wantConstant from './@ohos.app.ability.wantConstant'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace insightIntent { /** @@ -38,7 +39,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ExecuteMode { /** @@ -47,7 +49,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UI_ABILITY_FOREGROUND = 0, @@ -57,7 +60,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UI_ABILITY_BACKGROUND = 1, @@ -66,7 +70,8 @@ declare namespace insightIntent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UI_EXTENSION_ABILITY = 2, @@ -76,7 +81,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SERVICE_EXTENSION_ABILITY = 3, } @@ -88,7 +94,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ExecuteResult { /** @@ -98,7 +105,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ code: number; @@ -109,7 +117,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ result?: Record; @@ -120,7 +129,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ uris?: Array; @@ -135,7 +145,8 @@ declare namespace insightIntent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @stagemodelonly * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ flags?: number; } diff --git a/api/@ohos.app.ability.insightIntentDriver.d.ts b/api/@ohos.app.ability.insightIntentDriver.d.ts index b62db3747e7475a6e359d42a21d5b051affeda40..069c295ce4a0ce50dd5c9ae1b64c39453c5de2e2 100644 --- a/api/@ohos.app.ability.insightIntentDriver.d.ts +++ b/api/@ohos.app.ability.insightIntentDriver.d.ts @@ -30,7 +30,8 @@ import type insightIntent from './@ohos.app.ability.insightIntent'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace insightIntentDriver { /** @@ -40,7 +41,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ExecuteParam { /** @@ -50,7 +52,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -61,7 +64,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName: string; @@ -72,7 +76,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ abilityName: string; @@ -83,7 +88,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ insightIntentName: string; @@ -94,7 +100,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ insightIntentParam: Record; @@ -105,7 +112,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ executeMode: insightIntent.ExecuteMode; @@ -116,7 +124,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ displayId?: number; @@ -127,7 +136,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ uris?: Array; @@ -142,7 +152,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ flags?: number; } @@ -177,7 +188,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function execute(param: ExecuteParam, callback: AsyncCallback): void; @@ -211,7 +223,8 @@ declare namespace insightIntentDriver { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function execute(param: ExecuteParam): Promise; } diff --git a/api/@ohos.app.ability.wantAgent.d.ts b/api/@ohos.app.ability.wantAgent.d.ts index f59df2d72aeaea84003cb02e23b85629a7ef65b2..d661648014cf7c22cda4c9385bd84af4ff277d62 100644 --- a/api/@ohos.app.ability.wantAgent.d.ts +++ b/api/@ohos.app.ability.wantAgent.d.ts @@ -38,7 +38,8 @@ import { TriggerInfo as _TriggerInfo } from './wantAgent/triggerInfo'; * @namespace wantAgent * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace wantAgent { /** @@ -64,7 +65,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleName(agent: WantAgent, callback: AsyncCallback): void; @@ -91,7 +93,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleName(agent: WantAgent): Promise; @@ -118,7 +121,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUid(agent: WantAgent, callback: AsyncCallback): void; @@ -161,7 +165,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getWant(agent: WantAgent, callback: AsyncCallback): void; @@ -177,7 +182,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getWant(agent: WantAgent): Promise; @@ -204,7 +210,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancel(agent: WantAgent, callback: AsyncCallback): void; @@ -231,7 +238,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancel(agent: WantAgent): Promise; @@ -256,7 +264,8 @@ declare namespace wantAgent { * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback): void; @@ -281,7 +290,8 @@ declare namespace wantAgent { * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback): void; @@ -306,7 +316,8 @@ declare namespace wantAgent { * 2. Incorrect parameter types. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function equal(agent: WantAgent, otherAgent: WantAgent): Promise; @@ -333,7 +344,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getWantAgent(info: WantAgentInfo, callback: AsyncCallback): void; @@ -360,7 +372,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getWantAgent(info: WantAgentInfo): Promise; @@ -389,7 +402,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOperationType(agent: WantAgent, callback: AsyncCallback): void; @@ -418,7 +432,8 @@ declare namespace wantAgent { * @throws { BusinessError } 16000151 - Invalid wantagent object. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOperationType(agent: WantAgent): Promise; @@ -449,7 +464,8 @@ declare namespace wantAgent { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum WantAgentFlags { /** @@ -465,7 +481,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ONE_TIME_FLAG = 0, @@ -482,7 +499,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NO_BUILD_FLAG, @@ -499,7 +517,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL_PRESENT_FLAG, @@ -516,7 +535,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UPDATE_PRESENT_FLAG, @@ -531,7 +551,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CONSTANT_FLAG, @@ -546,7 +567,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPLACE_ELEMENT, @@ -561,7 +583,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPLACE_ACTION, @@ -576,7 +599,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPLACE_URI, @@ -591,7 +615,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPLACE_ENTITIES, @@ -606,7 +631,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPLACE_BUNDLE } @@ -624,7 +650,8 @@ declare namespace wantAgent { * @enum { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum OperationType { /** @@ -638,7 +665,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN_TYPE = 0, @@ -653,7 +681,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ START_ABILITY, @@ -668,7 +697,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ START_ABILITIES, @@ -683,7 +713,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ START_SERVICE, @@ -698,7 +729,8 @@ declare namespace wantAgent { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SEND_COMMON_EVENT, @@ -708,7 +740,8 @@ declare namespace wantAgent { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ START_SERVICE_EXTENSION = 6 } @@ -726,7 +759,8 @@ declare namespace wantAgent { * @typedef CompleteData * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface CompleteData { /** @@ -742,7 +776,8 @@ declare namespace wantAgent { * @type { WantAgent } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ info: WantAgent; @@ -759,7 +794,8 @@ declare namespace wantAgent { * @type { Want } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ want: Want; @@ -776,7 +812,8 @@ declare namespace wantAgent { * @type { number } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ finalCode: number; @@ -793,7 +830,8 @@ declare namespace wantAgent { * @type { string } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ finalData: string; @@ -817,7 +855,8 @@ declare namespace wantAgent { * @type { ?Record } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ extraInfo?: Record; } @@ -835,7 +874,8 @@ declare namespace wantAgent { * @typedef { _TriggerInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type TriggerInfo = _TriggerInfo; @@ -852,7 +892,8 @@ declare namespace wantAgent { * @typedef { _WantAgentInfo } * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type WantAgentInfo = _WantAgentInfo; } @@ -862,7 +903,8 @@ declare namespace wantAgent { * * @typedef { object } * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type WantAgent = object; diff --git a/api/@ohos.app.ability.wantConstant.d.ts b/api/@ohos.app.ability.wantConstant.d.ts index 85b131dc8479c9e8540c208158495a81cce26e14..9405bda651ee8578ee563988cdbb1b54fef1d26d 100644 --- a/api/@ohos.app.ability.wantConstant.d.ts +++ b/api/@ohos.app.ability.wantConstant.d.ts @@ -31,7 +31,8 @@ * @namespace wantConstant * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace wantConstant { /** @@ -47,7 +48,8 @@ declare namespace wantConstant { * @enum { string } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum Params { /** @@ -55,7 +57,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DLP_PARAMS_SANDBOX = 'ohos.dlp.params.sandbox', @@ -64,7 +67,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DLP_PARAMS_BUNDLE_NAME = 'ohos.dlp.params.bundleName', @@ -73,7 +77,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DLP_PARAMS_MODULE_NAME = 'ohos.dlp.params.moduleName', @@ -82,7 +87,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DLP_PARAMS_ABILITY_NAME = 'ohos.dlp.params.abilityName', @@ -91,7 +97,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DLP_PARAMS_INDEX = 'ohos.dlp.params.index', @@ -100,7 +107,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ HIDE_SENSITIVE_TYPE = 'ohos.media.params.hideSensitiveType', @@ -117,7 +125,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ABILITY_BACK_TO_OTHER_MISSION_STACK = 'ability.params.backToOtherMissionStack', @@ -132,7 +141,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ABILITY_RECOVERY_RESTART = 'ohos.ability.params.abilityRecoveryRestart', @@ -147,7 +157,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_TITLE_KEY = 'ohos.extra.param.key.contentTitle', @@ -162,7 +173,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SHARE_ABSTRACT_KEY = 'ohos.extra.param.key.shareAbstract', @@ -177,7 +189,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SHARE_URL_KEY = 'ohos.extra.param.key.shareUrl', @@ -196,7 +209,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SUPPORT_CONTINUE_PAGE_STACK_KEY = 'ohos.extra.param.key.supportContinuePageStack', @@ -215,7 +229,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SUPPORT_CONTINUE_SOURCE_EXIT_KEY = 'ohos.extra.param.key.supportContinueSourceExit', @@ -225,7 +240,8 @@ declare namespace wantConstant { * @syscap SystemCapability.Ability.AbilityBase * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSERT_FAULT_SESSION_ID = 'ohos.ability.params.asssertFaultSessionId', @@ -234,7 +250,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SHOW_MODE_KEY = 'ohos.extra.param.key.showMode', @@ -243,7 +260,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PARAMS_STREAM = 'ability.params.stream', @@ -252,7 +270,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_CLONE_INDEX_KEY = 'ohos.extra.param.key.appCloneIndex', @@ -261,7 +280,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CALLER_REQUEST_CODE = 'ohos.extra.param.key.callerRequestCode', @@ -270,7 +290,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_PATH = 'ohos.param.atomicservice.pagePath', @@ -279,7 +300,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ROUTER_NAME = 'ohos.param.atomicservice.routerName', @@ -288,7 +310,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_SOURCE_FILE = 'ohos.param.atomicservice.pageSourceFile', @@ -297,7 +320,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ BUILD_FUNCTION = 'ohos.param.atomicservice.buildFunction', @@ -306,7 +330,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SUB_PACKAGE_NAME = 'ohos.param.atomicservice.subpackageName', @@ -314,7 +339,8 @@ declare namespace wantConstant { * Indicates the param of app instance key. * * @syscap SystemCapability.Ability.AbilityBase - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_INSTANCE_KEY = 'ohos.extra.param.key.appInstance', @@ -322,7 +348,8 @@ declare namespace wantConstant { * Indicates the param of creating a new instance. * * @syscap SystemCapability.Ability.AbilityBase - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ CREATE_APP_INSTANCE_KEY = 'ohos.extra.param.key.createAppInstance', @@ -330,7 +357,8 @@ declare namespace wantConstant { * Indicates the app clone index of caller. * * @syscap SystemCapability.Ability.AbilityBase - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ CALLER_APP_CLONE_INDEX = 'ohos.param.callerAppCloneIndex', @@ -341,7 +369,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ LAUNCH_REASON_MESSAGE = 'ohos.params.launchReasonMessage', } @@ -359,7 +388,8 @@ declare namespace wantConstant { * @enum { number } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum Flags { /** @@ -373,7 +403,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_AUTH_READ_URI_PERMISSION = 0x00000001, @@ -388,14 +419,16 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_AUTH_WRITE_URI_PERMISSION = 0x00000002, /** * Indicates that the URI can be persisted by the callee. * @syscap SystemCapability.Ability.AbilityBase - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_AUTH_PERSISTABLE_URI_PERMISSION = 0x00000040, @@ -410,7 +443,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_INSTALL_ON_DEMAND = 0x00000800, @@ -418,7 +452,8 @@ declare namespace wantConstant { * Collaborative target applications in the distributed scheduling system can be pulled up. * * @syscap SystemCapability.Ability.AbilityBase - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_ABILITY_ON_COLLABORATE = 0x00002000, @@ -426,7 +461,8 @@ declare namespace wantConstant { * Indicates that if implicit start ability couldn't match any application, no tip dialog will be pulled up. * * @syscap SystemCapability.Ability.AbilityBase - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_START_WITHOUT_TIPS = 0x40000000 } @@ -437,7 +473,8 @@ declare namespace wantConstant { * @enum { number } * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ShowMode { /** @@ -445,7 +482,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW = 0, @@ -454,7 +492,8 @@ declare namespace wantConstant { * * @syscap SystemCapability.Ability.AbilityBase * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED_FULL = 1 } diff --git a/api/@ohos.app.appstartup.StartupConfigEntry.d.ts b/api/@ohos.app.appstartup.StartupConfigEntry.d.ts index 18817c665c1eca50229f5545a7bceda825cf7645..5b5b8bb7191527bded20465ffbc0af99548947db 100644 --- a/api/@ohos.app.appstartup.StartupConfigEntry.d.ts +++ b/api/@ohos.app.appstartup.StartupConfigEntry.d.ts @@ -37,4 +37,4 @@ export default class StartupConfigEntry { * @since 12 */ onConfig?(): StartupConfig; -} +} \ No newline at end of file diff --git a/api/@ohos.app.appstartup.StartupTask.d.ets b/api/@ohos.app.appstartup.StartupTask.d.ets old mode 100755 new mode 100644 index 256f5d57cd0c5c5ca3923159e0f4cd4b0d3d3000..ca1776a17c59afa9d9ef66d01aec7127c0c5a468 --- a/api/@ohos.app.appstartup.StartupTask.d.ets +++ b/api/@ohos.app.appstartup.StartupTask.d.ets @@ -51,4 +51,4 @@ export default class StartupTask { * @since 12 */ init(context: AbilityStageContext): Promise; -} +} \ No newline at end of file diff --git a/api/@ohos.app.form.FormExtensionAbility.d.ts b/api/@ohos.app.form.FormExtensionAbility.d.ts index f6f37905b4d3654fa99a569699debdfd0ff4e1f9..cbd0d1bd9cb2c650659b82cb974681ac3c4e3f13 100644 --- a/api/@ohos.app.form.FormExtensionAbility.d.ts +++ b/api/@ohos.app.form.FormExtensionAbility.d.ts @@ -19,10 +19,26 @@ */ import formBindingData from './@ohos.app.form.formBindingData'; +/*** if arkts 1.1 */ import formInfo from './@ohos.app.form.formInfo'; +/*** endif */ import FormExtensionContext from './application/FormExtensionContext'; import Want from './@ohos.app.ability.Want'; +/*** if arkts 1.1 */ import { Configuration } from './@ohos.app.ability.Configuration'; +/*** endif */ + +/** + * Called when this ability breaks the last link, notifying the provider that the provider process is about to stop. + * + * @typedef { function } + * @syscap SystemCapability.Ability.Form + * @stagemodelonly + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +type OnStopFn = () => void; /** * class of form extension. @@ -37,9 +53,10 @@ import { Configuration } from './@ohos.app.ability.Configuration'; * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class FormExtensionAbility { +declare class FormExtensionAbility { /** * Indicates form extension context. * @@ -55,7 +72,8 @@ export default class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ context: FormExtensionContext; @@ -82,7 +100,8 @@ export default class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onAddForm(want: Want): formBindingData.FormBindingData; @@ -101,7 +120,8 @@ export default class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onCastToNormalForm(formId: string): void; @@ -130,7 +150,8 @@ export default class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ onUpdateForm(formId: string, wantParams?: Record): void; @@ -163,7 +184,8 @@ export default class FormExtensionAbility { * becomes invisible. * @syscap SystemCapability.Ability.Form * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onChangeFormVisibility(newStatus: Record): void; @@ -190,7 +212,8 @@ export default class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onFormEvent(formId: string, message: string): void; @@ -211,7 +234,8 @@ export default class FormExtensionAbility { * @syscap SystemCapability.Ability.Form * @stagemodelonly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onRemoveForm(formId: string): void; @@ -316,4 +340,17 @@ export default class FormExtensionAbility { * @since 12 */ onStop?(): void; + + /** + * Called when this ability breaks the last link, notifying the provider that the provider process is about to stop. + * + * @type { ?OnStopFn } + * @syscap SystemCapability.Ability.Form + * @stagemodelonly + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + onStop?: OnStopFn; } +export default FormExtensionAbility; diff --git a/api/@ohos.app.form.formBindingData.d.ts b/api/@ohos.app.form.formBindingData.d.ts index d7b279e54b111317718e6707fda1e6fe50ee6f53..356ef5858a53dec459c75e34a69037bc4622cc86 100644 --- a/api/@ohos.app.form.formBindingData.d.ts +++ b/api/@ohos.app.form.formBindingData.d.ts @@ -16,10 +16,9 @@ /** * @file * @kit FormKit + * @arkts 1.1&1.2 */ -import { BusinessError } from './@ohos.base'; - /** * Interface of formBindingData. * @@ -33,7 +32,8 @@ import { BusinessError } from './@ohos.base'; * @namespace formBindingData * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace formBindingData { /** @@ -55,7 +55,8 @@ declare namespace formBindingData { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function createFormBindingData(obj?: Object | string): FormBindingData; @@ -72,7 +73,8 @@ declare namespace formBindingData { * @typedef FormBindingData * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface FormBindingData { /** @@ -88,7 +90,8 @@ declare namespace formBindingData { * @type { Object } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ data: Object; @@ -107,7 +110,8 @@ declare namespace formBindingData { * @syscap SystemCapability.Ability.Form * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ proxies?: Array; } @@ -127,7 +131,8 @@ declare namespace formBindingData { * @syscap SystemCapability.Ability.Form * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ProxyData { /** @@ -145,7 +150,8 @@ declare namespace formBindingData { * @syscap SystemCapability.Ability.Form * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ key: string; @@ -164,7 +170,8 @@ declare namespace formBindingData { * @syscap SystemCapability.Ability.Form * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ subscriberId?: string; } diff --git a/api/@ohos.app.form.formInfo.d.ts b/api/@ohos.app.form.formInfo.d.ts index 086eaf2a9e1dfb5b4bf1d7fb1b50c0cc48c59034..18ca442af17561e45c879ff8fdcdfed516e7e4a1 100644 --- a/api/@ohos.app.form.formInfo.d.ts +++ b/api/@ohos.app.form.formInfo.d.ts @@ -33,7 +33,8 @@ import Want from './@ohos.app.ability.Want'; * @namespace formInfo * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace formInfo { /** @@ -49,7 +50,8 @@ declare namespace formInfo { * @typedef FormInfo * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface FormInfo { /** @@ -65,7 +67,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -82,7 +85,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName: string; @@ -99,7 +103,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ abilityName: string; @@ -116,7 +121,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -126,7 +132,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ displayName: string; @@ -136,7 +143,8 @@ declare namespace formInfo { * @type { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ displayNameId: number; @@ -153,7 +161,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ description: string; @@ -170,7 +179,8 @@ declare namespace formInfo { * @type { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ descriptionId: number; @@ -187,7 +197,8 @@ declare namespace formInfo { * @type { FormType } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type: FormType; @@ -204,7 +215,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ jsComponentName: string; @@ -221,21 +233,11 @@ declare namespace formInfo { * @type { ColorMode } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ colorMode: ColorMode; - /** - * Obtains the rendering mode of the form. - * - * @type { ?RenderingMode } - * @readonly - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 18 - */ - readonly renderingMode?: RenderingMode; - /** * Checks whether this form is a default form. * @@ -249,7 +251,8 @@ declare namespace formInfo { * @type { boolean } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isDefault: boolean; @@ -266,7 +269,8 @@ declare namespace formInfo { * @type { boolean } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ updateEnabled: boolean; @@ -283,7 +287,8 @@ declare namespace formInfo { * @type { boolean } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ formVisibleNotify: boolean; @@ -300,7 +305,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ scheduledUpdateTime: string; @@ -317,7 +323,8 @@ declare namespace formInfo { * @type { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ formConfigAbility: string; @@ -334,7 +341,8 @@ declare namespace formInfo { * @type { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ updateDuration: number; @@ -351,7 +359,8 @@ declare namespace formInfo { * @type { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ defaultDimension: number; @@ -368,7 +377,8 @@ declare namespace formInfo { * @type { Array } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ supportDimensions: Array; @@ -385,7 +395,8 @@ declare namespace formInfo { * @type { Record } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ customizeData: Record; @@ -402,7 +413,8 @@ declare namespace formInfo { * @type { boolean } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isDynamic: boolean; @@ -413,7 +425,8 @@ declare namespace formInfo { * @default false * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ transparencyEnabled: boolean; @@ -423,7 +436,8 @@ declare namespace formInfo { * @type { Array } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ supportedShapes: Array; @@ -435,7 +449,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly previewImages?: Array; @@ -446,9 +461,61 @@ declare namespace formInfo { * @readonly * @syscap SystemCapability.Ability.Form * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly enableBlurBackground?: boolean; + + /** + * Obtains the rendering mode of the form. + * + * @type { ?RenderingMode } + * @readonly + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + readonly renderingMode?: RenderingMode; + } + + /** + * Rendering mode. + * + * @enum { number } + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + enum RenderingMode { + /** + * Auto color mode. + * + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + AUTO_COLOR = 0, + /** + * Full color mode. + * + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + FULL_COLOR = 1, + /** + * Single color mode. + * + * @syscap SystemCapability.Ability.Form + * @systemapi + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + SINGLE_COLOR = 2 } /** @@ -464,7 +531,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormType { /** @@ -478,7 +546,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JS = 1, @@ -493,7 +562,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ eTS = 2 } @@ -511,7 +581,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ColorMode { /** @@ -525,7 +596,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MODE_AUTO = -1, @@ -540,7 +612,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MODE_DARK = 0, @@ -555,48 +628,12 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MODE_LIGHT = 1 } - /** - * Rendering mode. - * - * @enum { number } - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 18 - */ - enum RenderingMode { - /** - * Auto color mode. - * - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 18 - */ - AUTO_COLOR = 0, - - /** - * Full color mode. - * - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 18 - */ - FULL_COLOR = 1, - - /** - * Single color mode. - * - * @syscap SystemCapability.Ability.Form - * @systemapi - * @since 18 - */ - SINGLE_COLOR = 2 - } - /** * Provides state information about a form. * @@ -610,7 +647,8 @@ declare namespace formInfo { * @typedef FormStateInfo * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface FormStateInfo { /** @@ -626,7 +664,8 @@ declare namespace formInfo { * @type { FormState } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ formState: FormState; @@ -643,7 +682,8 @@ declare namespace formInfo { * @type { Want } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ want: Want; } @@ -661,7 +701,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormState { /** @@ -675,7 +716,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = -1, @@ -690,7 +732,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -705,7 +748,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ READY = 1 } @@ -723,7 +767,8 @@ declare namespace formInfo { * @enum { string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormParam { /** @@ -747,9 +792,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - IDENTITY_KEY = 'ohos.extra.param.key.form_identity', + IDENTITY_KEY = "ohos.extra.param.key.form_identity", /** * Indicates the key specifying the grid style of the form to be obtained, which is represented as @@ -772,9 +818,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - DIMENSION_KEY = 'ohos.extra.param.key.form_dimension', + DIMENSION_KEY = "ohos.extra.param.key.form_dimension", /** * Indicates the key specifying the name of the form to be obtained, which is represented as @@ -797,9 +844,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - NAME_KEY = 'ohos.extra.param.key.form_name', + NAME_KEY = "ohos.extra.param.key.form_name", /** * Indicates the key specifying the name of the module to which the form to be obtained belongs, which is @@ -826,9 +874,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - MODULE_NAME_KEY = 'ohos.extra.param.key.module_name', + MODULE_NAME_KEY = "ohos.extra.param.key.module_name", /** * Indicates the key specifying the width of the form to be obtained, which is represented as @@ -851,9 +900,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - WIDTH_KEY = 'ohos.extra.param.key.form_width', + WIDTH_KEY = "ohos.extra.param.key.form_width", /** * Indicates the key specifying the height of the form to be obtained, which is represented as @@ -876,9 +926,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - HEIGHT_KEY = 'ohos.extra.param.key.form_height', + HEIGHT_KEY = "ohos.extra.param.key.form_height", /** * Indicates the key specifying whether a form is temporary, which is represented as @@ -901,9 +952,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - TEMPORARY_KEY = 'ohos.extra.param.key.form_temporary', + TEMPORARY_KEY = "ohos.extra.param.key.form_temporary", /** * Indicates the key specifying the name of the bundle to be obtained, which is represented as @@ -926,9 +978,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - BUNDLE_NAME_KEY = 'ohos.extra.param.key.bundle_name', + BUNDLE_NAME_KEY = "ohos.extra.param.key.bundle_name", /** * Indicates the key specifying the name of the ability to be obtained, which is represented as @@ -951,9 +1004,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - ABILITY_NAME_KEY = 'ohos.extra.param.key.ability_name', + ABILITY_NAME_KEY = "ohos.extra.param.key.ability_name", /** * Indicates the key specifying whether a form type is theme, which is represented as @@ -965,7 +1019,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ THEME_KEY = 'ohos.extra.param.key.form_is_theme', @@ -979,9 +1034,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - DEVICE_ID_KEY = 'ohos.extra.param.key.device_id', + DEVICE_ID_KEY = "ohos.extra.param.key.device_id", /** * Indicates the key specifying the launch reason of the form to be obtained, which is represented as @@ -1004,9 +1060,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - LAUNCH_REASON_KEY = 'ohos.extra.param.key.form_launch_reason', + LAUNCH_REASON_KEY = "ohos.extra.param.key.form_launch_reason", /** * Indicates the key specifying the custom data of the form to be obtained, which is represented as @@ -1033,9 +1090,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - PARAM_FORM_CUSTOMIZE_KEY = 'ohos.extra.param.key.form_customize', + PARAM_FORM_CUSTOMIZE_KEY = "ohos.extra.param.key.form_customize", /** * Indicates the key specifying the form location, which is represented as @@ -1046,7 +1104,8 @@ declare namespace formInfo { * }. * * @syscap SystemCapability.Ability.Form - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_LOCATION_KEY = 'ohos.extra.param.key.form_location', @@ -1071,7 +1130,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_RENDERING_MODE_KEY = 'ohos.extra.param.key.form_rendering_mode', @@ -1085,7 +1145,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ HOST_BG_INVERSE_COLOR_KEY = 'ohos.extra.param.key.host_bg_inverse_color', @@ -1099,7 +1160,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_PERMISSION_NAME_KEY = 'ohos.extra.param.key.permission_name', @@ -1113,7 +1175,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_PERMISSION_GRANTED_KEY = 'ohos.extra.param.key.permission_granted', } @@ -1133,7 +1196,8 @@ declare namespace formInfo { * @typedef FormInfoFilter * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface FormInfoFilter { /** @@ -1143,7 +1207,8 @@ declare namespace formInfo { * @type { ?string } * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName?: string; @@ -1162,7 +1227,8 @@ declare namespace formInfo { * @type { ?string } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName?: string; @@ -1173,7 +1239,8 @@ declare namespace formInfo { * @type { ?Array } * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ supportedDimensions?: Array; @@ -1184,7 +1251,8 @@ declare namespace formInfo { * @type { ?Array } * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ supportedShapes?: Array; } @@ -1202,7 +1270,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormDimension { /** @@ -1216,7 +1285,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_1_2 = 1, @@ -1231,7 +1301,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_2_2, @@ -1246,7 +1317,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_2_4, @@ -1261,7 +1333,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_4_4, @@ -1276,7 +1349,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ Dimension_2_1, @@ -1285,25 +1359,28 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - DIMENSION_1_1, + DIMENSION_1_1 = 6, /** * 6 x 4 form * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - DIMENSION_6_4, + DIMENSION_6_4 = 7, /** * 2 x 3 form used for wearable devices * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_2_3 = 8, @@ -1312,7 +1389,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ DIMENSION_3_3 = 9, @@ -1321,18 +1399,20 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - DIMENSION_3_4 = 10, + DIMENSION_3_4 = 10 } - /** + /** * Defines the FormShape enum. * * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormShape { /** @@ -1340,7 +1420,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RECT = 1, @@ -1349,9 +1430,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - CIRCLE, + CIRCLE = 2 } /** @@ -1367,7 +1449,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum VisibilityType { /** @@ -1385,7 +1468,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, /** @@ -1403,7 +1487,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_VISIBLE = 1, /** @@ -1421,9 +1506,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - FORM_INVISIBLE + FORM_INVISIBLE = 2 } /** @@ -1439,7 +1525,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum LaunchReason { /** @@ -1453,7 +1540,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_DEFAULT = 1, /** @@ -1467,9 +1555,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - FORM_SHARE + FORM_SHARE = 2 } /** @@ -1479,7 +1568,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PublishFormResult { /** @@ -1489,7 +1579,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ code: PublishFormErrorCode; @@ -1500,7 +1591,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ message: string; } @@ -1512,7 +1604,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PublishFormErrorCode { /** @@ -1521,9 +1614,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - SUCCESS, + SUCCESS = 0, /** * Host has no space to publish form. @@ -1531,9 +1625,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - NO_SPACE, + NO_SPACE = 1, /** * Check param failed. @@ -1541,9 +1636,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - PARAM_ERROR, + PARAM_ERROR = 2, /** * Internal error occurs during form processing. @@ -1551,9 +1647,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - INTERNAL_ERROR, + INTERNAL_ERROR = 3 } /** @@ -1563,7 +1660,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface FormProviderFilter { /** @@ -1573,7 +1671,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -1584,9 +1683,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - formName?: string; + formName ?: string; /** * Obtains the module name of the provider application module. @@ -1595,9 +1695,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - moduleName?: string; + moduleName ?: string; /** * Obtains the ability name of the provider application module. @@ -1606,9 +1707,10 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - abilityName?: string; + abilityName ?: string; /** * Indicates whether to include unused form. @@ -1618,7 +1720,8 @@ declare namespace formInfo { * @syscap SystemCapability.Ability.Form * @systemapi * @stagemodelonly - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isUnusedIncluded?: boolean; } @@ -1629,7 +1732,8 @@ declare namespace formInfo { * @typedef RunningFormInfo * @syscap SystemCapability.Ability.Form * @systemapi hide this for inner system use - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface RunningFormInfo { /** @@ -1640,7 +1744,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly formId: string; @@ -1652,7 +1757,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly bundleName: string; @@ -1664,7 +1770,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly hostBundleName: string; @@ -1676,7 +1783,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly formLocation: FormLocation; @@ -1688,7 +1796,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly visibilityType: VisibilityType; @@ -1700,7 +1809,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly moduleName: string; @@ -1712,7 +1822,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly abilityName: string; @@ -1724,7 +1835,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly formName: string; @@ -1736,7 +1848,8 @@ declare namespace formInfo { * @default - * @syscap SystemCapability.Ability.Form * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly dimension: number; @@ -1748,7 +1861,8 @@ declare namespace formInfo { * @readonly * @syscap SystemCapability.Ability.Form * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly formUsageState: FormUsageState; @@ -1759,7 +1873,8 @@ declare namespace formInfo { * @readonly * @syscap SystemCapability.Ability.Form * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly formDescription: string; @@ -1771,7 +1886,8 @@ declare namespace formInfo { * @readonly * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly extraData?: Record; } @@ -1782,7 +1898,8 @@ declare namespace formInfo { * @enum { number } * @syscap SystemCapability.Ability.Form * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormUsageState { /** @@ -1790,7 +1907,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ USED = 0, /** @@ -1798,9 +1916,10 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - UNUSED = 1, + UNUSED = 1 } /** @@ -1811,13 +1930,22 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Defines the FormLocation enum. + * + * @enum { number } + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ enum FormLocation { /** * Form is on the other location. * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OTHER = -1, @@ -1828,6 +1956,13 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Form is on the desktop + * + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ DESKTOP = 0, /** @@ -1837,6 +1972,13 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Form is on the form center. + * + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ FORM_CENTER = 1, /** @@ -1846,6 +1988,13 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Form is on the form manager. + * + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ FORM_MANAGER = 2, /** @@ -1855,6 +2004,13 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Form is on the negative screen. + * + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ NEGATIVE_SCREEN = 3, /** @@ -1862,7 +2018,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_CENTER_NEGATIVE_SCREEN = 4, @@ -1871,7 +2028,8 @@ declare namespace formInfo { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM_MANAGER_NEGATIVE_SCREEN = 5, @@ -1882,6 +2040,13 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Form is on the screen lock. + * + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ SCREEN_LOCK = 6, /** @@ -1891,6 +2056,13 @@ declare namespace formInfo { * @systemapi * @since 12 */ + /** + * Form is on the ai suggestion. + * + * @syscap SystemCapability.Ability.Form + * @since 20 + * @arkts 1.1&1.2 + */ AI_SUGGESTION = 7, } } diff --git a/api/@ohos.app.form.formProvider.d.ts b/api/@ohos.app.form.formProvider.d.ts index 061ec9d9763e6d2da657ac0fc9addbd1944ba071..a8a5583f4abded65212bc3a4e06c95e15b93bbc3 100644 --- a/api/@ohos.app.form.formProvider.d.ts +++ b/api/@ohos.app.form.formProvider.d.ts @@ -20,7 +20,9 @@ import { AsyncCallback } from './@ohos.base'; import formBindingData from './@ohos.app.form.formBindingData'; +/*** if arkts 1.1 */ import formInfo from './@ohos.app.form.formInfo'; +/*** endif */ import Want from './@ohos.app.ability.Want'; /** @@ -36,7 +38,8 @@ import Want from './@ohos.app.ability.Want'; * @namespace formProvider * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace formProvider { /** @@ -74,7 +77,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback): void; @@ -113,7 +117,8 @@ declare namespace formProvider { * @throws { BusinessError } 16501003 - The form cannot be operated by the current application. * @syscap SystemCapability.Ability.Form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function setFormNextRefreshTime(formId: string, minute: number): Promise; @@ -406,22 +411,6 @@ declare namespace formProvider { */ function getPublishedFormInfos(): Promise>; - /** - * Open the view of forms belonging to current bundle. - * Client to communication with FormManagerService. - * - * @param { Want } want - The want of the form to open. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. - * @throws { BusinessError } 16500050 - IPC connection error. - * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. - * @throws { BusinessError } 16501000 - An internal functional error occurred. - * @syscap SystemCapability.Ability.Form - * @atomicservice - * @since 18 - */ - function openFormManager(want: Want): void; - /** * Open the form edit ability * @@ -439,5 +428,21 @@ declare namespace formProvider { * @since 18 */ function openFormEditAbility(abilityName: string, formId: string, isMainPage?: boolean): void; + + /** + * Open the view of forms belonging to current bundle. + * Client to communication with FormManagerService. + * + * @param { Want } want - The want of the form to open. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. + * @throws { BusinessError } 16500050 - IPC connection error. + * @throws { BusinessError } 16500100 - Failed to obtain the configuration information. + * @throws { BusinessError } 16501000 - An internal functional error occurred. + * @syscap SystemCapability.Ability.Form + * @atomicservice + * @since 18 + */ + function openFormManager(want: Want): void; } export default formProvider; diff --git a/api/@ohos.application.AccessibilityExtensionAbility.d.ets b/api/@ohos.application.AccessibilityExtensionAbility.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..184e82be078ea5edb3cccdbe20e8bd7186403f1a --- /dev/null +++ b/api/@ohos.application.AccessibilityExtensionAbility.d.ets @@ -0,0 +1,61 @@ +/* + * Copyright (c) 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 AccessibilityKit + */ + +/** + * Indicates rectangle. + * + * @typedef Rect + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 20 + */ +export class Rect { + /** + * The left position of Rect + * + * @type { number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ + left: number; + /** + * The top position of Rect + * + * @type { number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ + top: number; + /** + * The width position of Rect + * + * @type { number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ + width: number; + /** + * The height position of Rect + * + * @type { number } + * @syscap SystemCapability.BarrierFree.Accessibility.Core + * @since 9 + */ + height: number; +} \ No newline at end of file diff --git a/api/@ohos.application.BackupExtensionAbility.d.ts b/api/@ohos.application.BackupExtensionAbility.d.ts index dc96d9865d9fc6ee0d25b8324fdf1a4239f03394..8dede02743fddf7fd385b3a29cc8831772b12e5d 100644 --- a/api/@ohos.application.BackupExtensionAbility.d.ts +++ b/api/@ohos.application.BackupExtensionAbility.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2024 Huawei Device Co., Ltd. + * Copyright (c) 2024-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 @@ -18,7 +18,9 @@ * @kit CoreFileKit */ +/*** if arkts 1.1 */ import type BackupExtensionContext from './@ohos.file.BackupExtensionContext'; +/*** endif */ /** * Describe bundle version @@ -26,7 +28,8 @@ import type BackupExtensionContext from './@ohos.file.BackupExtensionContext'; * @interface BundleVersion * @syscap SystemCapability.FileManagement.StorageService.Backup * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface BundleVersion { /** @@ -35,7 +38,8 @@ export interface BundleVersion { * @type { number } * @syscap SystemCapability.FileManagement.StorageService.Backup * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ code: number; @@ -45,7 +49,8 @@ export interface BundleVersion { * @type { string } * @syscap SystemCapability.FileManagement.StorageService.Backup * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; } @@ -55,9 +60,10 @@ export interface BundleVersion { * * @syscap SystemCapability.FileManagement.StorageService.Backup * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class BackupExtensionAbility { +declare class BackupExtensionAbility { /** * Indicates backup extension ability context. * @@ -82,7 +88,8 @@ export default class BackupExtensionAbility { * * @syscap SystemCapability.FileManagement.StorageService.Backup * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ onBackup(): void; @@ -107,7 +114,8 @@ export default class BackupExtensionAbility { * @param { BundleVersion } bundleVersion Bundle version to be restore. * @syscap SystemCapability.FileManagement.StorageService.Backup * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ onRestore(bundleVersion: BundleVersion): void; @@ -149,3 +157,5 @@ export default class BackupExtensionAbility { */ onProcess(): string; } + +export default BackupExtensionAbility; diff --git a/api/@ohos.application.DistributedExtensionAbility.d.ts b/api/@ohos.application.DistributedExtensionAbility.d.ts index 0ec7469f3a14a1aa210a112ee4ac6746302f4cd1..7abc5fb3e826a4aa00b11692fea465b2947faeca 100644 --- a/api/@ohos.application.DistributedExtensionAbility.d.ts +++ b/api/@ohos.application.DistributedExtensionAbility.d.ts @@ -27,7 +27,7 @@ import type DistributedExtensionContext from './@ohos.application.DistributedExt * * @syscap SystemCapability.DistributedSched.AppCollaboration * @stagemodelonly - * @since 18 + * @since 20 */ export default class DistributedExtensionAbility { @@ -38,7 +38,7 @@ export default class DistributedExtensionAbility { * @type { DistributedExtensionContext } * @syscap SystemCapability.DistributedSched.AppCollaboration * @stagemodelonly - * @since 18 + * @since 20 */ context: DistributedExtensionContext; @@ -48,7 +48,7 @@ export default class DistributedExtensionAbility { * @param { Want } want Indicates the want info of ability. * @syscap SystemCapability.DistributedSched.AppCollaboration * @stagemodelonly - * @since 18 + * @since 20 */ onCreate(want: Want): void; @@ -57,7 +57,7 @@ export default class DistributedExtensionAbility { * * @syscap SystemCapability.DistributedSched.AppCollaboration * @stagemodelonly - * @since 18 + * @since 20 */ onDestroy(): void; @@ -68,7 +68,7 @@ export default class DistributedExtensionAbility { * @returns { AbilityConstant.CollaborateResult } Return the result of onCollaborate. * @syscap SystemCapability.DistributedSched.AppCollaboration * @stagemodelonly - * @since 18 + * @since 20 */ onCollaborate(wantParam: Record): AbilityConstant.CollaborateResult; } diff --git a/api/@ohos.application.DistributedExtensionContext.d.ts b/api/@ohos.application.DistributedExtensionContext.d.ts index 17a0dde2503e1452f37ac10b67608ea6f9abb8e6..39fafcc2816cdb22e86b43f7d486627f2518066a 100644 --- a/api/@ohos.application.DistributedExtensionContext.d.ts +++ b/api/@ohos.application.DistributedExtensionContext.d.ts @@ -25,6 +25,6 @@ import type ExtensionContext from './application/ExtensionContext'; * @extends ExtensionContext * @syscap SystemCapability.DistributedSched.AppCollaboration * @stagemodelonly - * @since 18 + * @since 20 */ export default class DistributedExtensionContext extends ExtensionContext {} \ No newline at end of file diff --git a/api/@ohos.application.StaticSubscriberExtensionAbility.d.ts b/api/@ohos.application.StaticSubscriberExtensionAbility.d.ts index d238b3dcf966ef794b4a001cf76b596e00355d1d..07be8e330715186b95b4fe63830a3a1d9007e771 100644 --- a/api/@ohos.application.StaticSubscriberExtensionAbility.d.ts +++ b/api/@ohos.application.StaticSubscriberExtensionAbility.d.ts @@ -18,7 +18,9 @@ * @kit BasicServicesKit */ +/*** if arkts 1.1 */ import { CommonEventData } from './commonEvent/commonEventData'; +/*** endif */ import StaticSubscriberExtensionContext from './@ohos.application.StaticSubscriberExtensionContext'; /** @@ -27,9 +29,10 @@ import StaticSubscriberExtensionContext from './@ohos.application.StaticSubscrib * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class StaticSubscriberExtensionAbility { +declare class StaticSubscriberExtensionAbility { /** * Indicates configuration information about an ability context. * @@ -37,7 +40,8 @@ export default class StaticSubscriberExtensionAbility { * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ context: StaticSubscriberExtensionContext; @@ -52,3 +56,5 @@ export default class StaticSubscriberExtensionAbility { */ onReceiveEvent(event: CommonEventData): void; } + +export default StaticSubscriberExtensionAbility; \ No newline at end of file diff --git a/api/@ohos.application.StaticSubscriberExtensionContext.d.ts b/api/@ohos.application.StaticSubscriberExtensionContext.d.ts index 40f5d151d2097883ec6e8d4886a4061a4167dd4a..8cbab8cd89aedb9582ca6e1e754814ecc3a05c05 100644 --- a/api/@ohos.application.StaticSubscriberExtensionContext.d.ts +++ b/api/@ohos.application.StaticSubscriberExtensionContext.d.ts @@ -18,8 +18,10 @@ * @kit BasicServicesKit */ +/*** if arkts 1.1 */ import { AsyncCallback } from './@ohos.base'; import Want from './@ohos.app.ability.Want'; +/*** endif */ import ExtensionContext from './application/ExtensionContext'; /** @@ -29,9 +31,10 @@ import ExtensionContext from './application/ExtensionContext'; * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class StaticSubscriberExtensionContext extends ExtensionContext { +declare class StaticSubscriberExtensionContext extends ExtensionContext { /** * Starts a new ability. If the caller application is in foreground, you can use this method to start ability; * If the caller application is in the background, you need to apply for permission:ohos.permission.START_ABILITIES_FROM_BACKGROUND. @@ -96,3 +99,5 @@ export default class StaticSubscriberExtensionContext extends ExtensionContext { */ startAbility(want: Want): Promise; } + +export default StaticSubscriberExtensionContext; \ No newline at end of file diff --git a/api/@ohos.application.WindowExtensionAbility.d.ts b/api/@ohos.application.WindowExtensionAbility.d.ts index ee8a1b08b9e62f0ee78024a3c5e7f096aeffa47f..32ccd9c0e805d90d124fdc20c0861b3a04c3ea48 100644 --- a/api/@ohos.application.WindowExtensionAbility.d.ts +++ b/api/@ohos.application.WindowExtensionAbility.d.ts @@ -29,9 +29,10 @@ import window from './@ohos.window'; * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi hide for inner use. * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ -export default class WindowExtensionAbility { +declare class WindowExtensionAbility { /** * Indicates window extension ability context. * @@ -39,7 +40,8 @@ export default class WindowExtensionAbility { * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi hide for inner use. * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ context: WindowExtensionContext; @@ -50,7 +52,8 @@ export default class WindowExtensionAbility { * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi hide for inner use. * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onConnect(want: Want): void; @@ -61,7 +64,8 @@ export default class WindowExtensionAbility { * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi hide for inner use. * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onDisconnect(want: Want): void; @@ -72,11 +76,14 @@ export default class WindowExtensionAbility { * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi hide for inner use. * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ onWindowReady(window: window.Window): void; } +export default WindowExtensionAbility; + /** * The context of window extension. It allows access to * windowExtension-specific resources. @@ -85,6 +92,7 @@ export default class WindowExtensionAbility { * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type WindowExtensionContext = _WindowExtensionContext; diff --git a/api/@ohos.application.formError.d.ts b/api/@ohos.application.formError.d.ts index 41eedb71973c5f15a64929c1e5b46699e83f3878..2bdd74bd99e0909843b32bf275a0a86d2448a67b 100644 --- a/api/@ohos.application.formError.d.ts +++ b/api/@ohos.application.formError.d.ts @@ -23,7 +23,8 @@ * * @namespace formError * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace formError { /** @@ -31,14 +32,16 @@ declare namespace formError { * * @enum { number } * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ enum FormError { /** * A common internal error occurs during form processing. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_COMMON = 1, @@ -48,7 +51,8 @@ declare namespace formError { * and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED permissions. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_PERMISSION_DENY = 2, @@ -58,7 +62,8 @@ declare namespace formError { * consistent with those provided by the form provider. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_GET_INFO_FAILED = 4, @@ -67,7 +72,8 @@ declare namespace formError { * Ensure that the bundle to which the form to be added belongs is available. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_GET_BUNDLE_FAILED = 5, @@ -76,7 +82,8 @@ declare namespace formError { * Ensure that the grid style of the form is supported by the form provider. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_GET_LAYOUT_FAILED = 6, @@ -85,7 +92,8 @@ declare namespace formError { * parameters are valid. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_ADD_INVALID_PARAM = 7, @@ -94,7 +102,8 @@ declare namespace formError { * different from that obtained for the first time. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_CFG_NOT_MATCH_ID = 8, @@ -102,7 +111,8 @@ declare namespace formError { * The ID of the form to be operated does not exist in the Form Manager Service. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_NOT_EXIST_ID = 9, @@ -110,7 +120,8 @@ declare namespace formError { * Failed to bind the Form Manager Service to the provider service. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_BIND_PROVIDER_FAILED = 10, @@ -118,7 +129,8 @@ declare namespace formError { * The total number of added forms exceeds the maximum allowed by the system. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_MAX_SYSTEM_FORMS = 11, @@ -127,7 +139,8 @@ declare namespace formError { * exceeds the maximum allowed by the system. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_MAX_INSTANCES_PER_FORM = 12, @@ -136,7 +149,8 @@ declare namespace formError { * operated by the current application. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_OPERATION_FORM_NOT_SELF = 13, @@ -144,7 +158,8 @@ declare namespace formError { * The Form Manager Service failed to instruct the form provider to delete the form. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_PROVIDER_DEL_FAIL = 14, @@ -152,7 +167,8 @@ declare namespace formError { * The total number of added forms exceeds the maximum per client. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_MAX_FORMS_PER_CLIENT = 15, @@ -160,7 +176,8 @@ declare namespace formError { * The total number of added temp forms exceeds the maximum in system. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_MAX_SYSTEM_TEMP_FORMS = 16, @@ -168,7 +185,8 @@ declare namespace formError { * The module can not be find in system. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_FORM_NO_SUCH_MODULE = 17, @@ -176,7 +194,8 @@ declare namespace formError { * The ability can not be find in system. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_FORM_NO_SUCH_ABILITY = 18, @@ -184,7 +203,8 @@ declare namespace formError { * The dimension is not exist in the form. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_FORM_NO_SUCH_DIMENSION = 19, @@ -192,7 +212,8 @@ declare namespace formError { * The ability is not installed. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_FORM_FA_NOT_INSTALLED = 20, @@ -201,7 +222,8 @@ declare namespace formError { * the service is not started.Please try again after the service is started. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_SYSTEM_RESPONSES_FAILED = 30, @@ -213,7 +235,8 @@ declare namespace formError { * the request parameters. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_FORM_DUPLICATE_ADDED = 31, @@ -222,7 +245,8 @@ declare namespace formError { * the restoration is complete. * * @syscap SystemCapability.Ability.Form - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_IN_RECOVERY = 36, @@ -231,7 +255,8 @@ declare namespace formError { * * @syscap SystemCapability.Ability.Form * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ERR_DISTRIBUTED_SCHEDULE_FAILED = 37 } diff --git a/api/@ohos.application.testRunner.d.ts b/api/@ohos.application.testRunner.d.ts index b8433177c09aed8379d48a09db89f75b6c47a9bd..ea86d1c15bdffb3c8d6cba4fe063a05a8d754121 100644 --- a/api/@ohos.application.testRunner.d.ts +++ b/api/@ohos.application.testRunner.d.ts @@ -33,9 +33,10 @@ * @interface TestRunner * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ -export interface TestRunner { +interface TestRunner { /** * Prepare the unit testing environment for running test cases. * @@ -47,7 +48,8 @@ export interface TestRunner { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onPrepare(): void; @@ -62,9 +64,13 @@ export interface TestRunner { * * @syscap SystemCapability.Ability.AbilityRuntime.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onRun(): void; } +/*** if arkts 1.1 */ +export { TestRunner }; +/*** endif */ export default TestRunner; diff --git a/api/@ohos.application.uriPermissionManager.d.ts b/api/@ohos.application.uriPermissionManager.d.ts index 8ec43d996acfbcc99166403dd1545f777e91cbd1..f66b3f4a75a02581fbec477243e3a4222401f8bb 100644 --- a/api/@ohos.application.uriPermissionManager.d.ts +++ b/api/@ohos.application.uriPermissionManager.d.ts @@ -26,7 +26,8 @@ import type wantConstant from './@ohos.app.ability.wantConstant'; * * @namespace uriPermissionManager * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace uriPermissionManager { /** @@ -50,7 +51,8 @@ declare namespace uriPermissionManager { * @throws { BusinessError } 16000060 - A sandbox application cannot grant URI permission. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function grantUriPermission( uri: string, @@ -80,7 +82,8 @@ declare namespace uriPermissionManager { * @throws { BusinessError } 16000060 - A sandbox application cannot grant URI permission. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function grantUriPermission(uri: string, flag: wantConstant.Flags, targetBundleName: string): Promise; @@ -107,7 +110,8 @@ declare namespace uriPermissionManager { * @throws { BusinessError } 16000081 - Get target application info failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use. - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function grantUriPermission(uri: string, flag: wantConstant.Flags, targetBundleName: string, appCloneIndex: number): Promise; @@ -143,7 +147,8 @@ declare namespace uriPermissionManager { * @throws { BusinessError } 16000059 - Invalid URI type. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function revokeUriPermission(uri: string, targetBundleName: string, callback: AsyncCallback): void; @@ -179,7 +184,8 @@ declare namespace uriPermissionManager { * @throws { BusinessError } 16000059 - Invalid URI type. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function revokeUriPermission(uri: string, targetBundleName: string): Promise; @@ -199,9 +205,10 @@ declare namespace uriPermissionManager { * @throws { BusinessError } 16000081 - Get target application info failed. * @syscap SystemCapability.Ability.AbilityRuntime.Core * @systemapi hide this for inner system use - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - function revokeUriPermission(uri: string, targetBundleName: string, appCloneIndex: number): Promise; + function revokeUriPermission(uri: string, targetBundleName: string, appCloneIndex: number): Promise; } export default uriPermissionManager; \ No newline at end of file diff --git a/api/@ohos.arkui.UIContext.d.ts b/api/@ohos.arkui.UIContext.d.ts index 158ba31532d98d96d39d0153beb9195bd22df3d6..3b311511cacb93aacaf6e08bc2c9cfc5fa977fbd 100644 --- a/api/@ohos.arkui.UIContext.d.ts +++ b/api/@ohos.arkui.UIContext.d.ts @@ -23,11 +23,14 @@ import font from './@ohos.font'; import mediaQuery from './@ohos.mediaquery'; import type inspector from './@ohos.arkui.inspector'; import type observer from './@ohos.arkui.observer'; -import promptAction, { LevelOrder } from './@ohos.promptAction'; +import promptAction from './@ohos.promptAction'; +import { LevelOrder } from './@ohos.promptAction'; import router from './@ohos.router'; import type componentUtils from './@ohos.arkui.componentUtils'; +/*** if arkts 1.1 */ import { ComponentContent, FrameNode, Frame } from './@ohos.arkui.node'; import type { AnimatorOptions, AnimatorResult } from './@ohos.animator'; +/*** endif */ import { SimpleAnimatorOptions } from './@ohos.animator'; import type { Callback, AsyncCallback } from './@ohos.base'; import { MeasureOptions } from './@ohos.measure'; @@ -37,6 +40,28 @@ import image from './@ohos.multimedia.image'; import type common from './@ohos.app.ability.common'; import type pointer from './@ohos.multimodalInput.pointer'; +/*** if arkts 1.2 */ +import { ComponentContent, FrameNode, Frame } from '@ohos.arkui.node'; +import { AnimatorOptions, AnimatorResult } from './@ohos.animator'; +import { + ClickEvent, ExpectedFrameRateRange, DragItemInfo, AnimateParam, KeyframeAnimateParam, + KeyframeState, SheetOptions, PopupCommonOptions, MenuOptions, KeyEvent, Optional +} from './arkui/component/common'; +import { CustomBuilder } from './arkui/component/builder'; +import { GestureEvent, GestureRecognizer } from './arkui/component/gesture'; +import { ResourceStr, SizeOptions } from './arkui/component/units'; +import { Nullable, Color, FontStyle, WidthBreakpoint, HeightBreakpoint, PixelRoundMode } from './arkui/component/enums'; +import { TimePickerDialogOptions } from './arkui/component/timePicker'; +import { AlertDialogParamWithConfirm, AlertDialogParamWithButtons, AlertDialogParamWithOptions } from './arkui/component/alertDialog'; +import { ActionSheetOptions } from './arkui/component/actionSheet'; +import { TextPickerDialogOptions } from './arkui/component/textPicker'; +import { LocalStorage } from './arkui/stateManagement/storage/localStorage'; +import { DatePickerDialogOptions } from './arkui/component/datePicker'; +import { TabsController } from './arkui/component/tabs'; +import { Scroller } from './arkui/component/scroll'; +import { KeyProcessingMode } from './arkui/component/focus'; +import { TextMenuOptions } from './arkui/component/textCommon'; +/*** endif */ /** * class Font * @@ -50,9 +75,10 @@ import type pointer from './@ohos.multimodalInput.pointer'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ -export class Font { +export declare class Font { /** * Register a customized font in the FontManager. * @@ -68,7 +94,8 @@ export class Font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ registerFont(options: font.FontOptions): void; @@ -83,7 +110,8 @@ export class Font { * @returns { Array } A list of font names * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getSystemFontList(): Array; @@ -100,7 +128,8 @@ export class Font { * @returns { font.FontInfo } Returns the font info * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getFontByName(fontName: string): font.FontInfo; } @@ -118,9 +147,10 @@ export class Font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ -export class MediaQuery { +export declare class MediaQuery { /** * Sets the media query criteria and returns the corresponding listening handle * @@ -138,7 +168,8 @@ export class MediaQuery { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ matchMediaSync(condition: string): mediaQuery.MediaQueryListener; } @@ -154,9 +185,10 @@ export class MediaQuery { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ -export class UIInspector { +export declare class UIInspector { /** * Sets the component after layout or draw criteria and returns the corresponding listening handle * @param { string } id - component id. @@ -172,7 +204,8 @@ export class UIInspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ createComponentObserver(id: string): inspector.ComponentObserver; } @@ -198,9 +231,10 @@ export class UIInspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class Router { +export declare class Router { /** * Navigates to a specified page in the application based on the page URL and parameters. * @@ -232,7 +266,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushUrl(options: router.RouterOptions, callback: AsyncCallback): void; @@ -267,7 +302,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushUrl(options: router.RouterOptions): Promise; @@ -304,7 +340,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; @@ -341,7 +378,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushUrl(options: router.RouterOptions, mode: router.RouterMode): Promise; @@ -374,7 +412,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceUrl(options: router.RouterOptions, callback: AsyncCallback): void; @@ -407,7 +446,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceUrl(options: router.RouterOptions): Promise; @@ -442,7 +482,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceUrl(options: router.RouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; @@ -477,7 +518,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceUrl(options: router.RouterOptions, mode: router.RouterMode): Promise; @@ -496,7 +538,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ back(options?: router.RouterOptions): void; @@ -508,7 +551,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ back(index: number, params?: Object): void; @@ -525,7 +569,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ clear(): void; @@ -544,7 +589,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getLength(): string; @@ -563,7 +609,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getState(): router.RouterState; @@ -575,7 +622,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getStateByIndex(index: number): router.RouterState | undefined; @@ -587,7 +635,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getStateByUrl(url: string): Array; @@ -616,7 +665,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showAlertBeforeBackPage(options: router.EnableAlertOptions): void; @@ -633,7 +683,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ hideAlertBeforeBackPage(): void; @@ -652,7 +703,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getParams(): Object; @@ -685,7 +737,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback): void; @@ -718,7 +771,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushNamedRoute(options: router.NamedRouterOptions): Promise; @@ -753,7 +807,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; @@ -788,7 +843,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ pushNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Promise; @@ -819,7 +875,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceNamedRoute(options: router.NamedRouterOptions, callback: AsyncCallback): void; @@ -847,7 +904,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceNamedRoute(options: router.NamedRouterOptions): Promise; @@ -877,7 +935,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode, callback: AsyncCallback): void; @@ -910,7 +969,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ replaceNamedRoute(options: router.NamedRouterOptions, mode: router.RouterMode): Promise; } @@ -922,7 +982,8 @@ export class Router { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ declare type CustomBuilderWithId = (id: number) => void; @@ -933,7 +994,8 @@ declare type CustomBuilderWithId = (id: number) => void; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ export interface TargetInfo { /** @@ -943,7 +1005,8 @@ export interface TargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ id: string | number; @@ -954,7 +1017,8 @@ export interface TargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ componentId?: number; } @@ -972,9 +1036,10 @@ export interface TargetInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ -export class PromptAction { +export declare class PromptAction { /** * Displays the notification text. * @@ -1000,7 +1065,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showToast(options: promptAction.ShowToastOptions): void; @@ -1017,7 +1083,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ openToast(options: promptAction.ShowToastOptions): Promise; @@ -1033,7 +1100,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ closeToast(toastId: number): void; @@ -1079,7 +1147,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ showDialog(options: promptAction.ShowDialogOptions, callback: AsyncCallback): void; @@ -1110,7 +1179,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showDialog(options: promptAction.ShowDialogOptions): Promise; @@ -1145,7 +1215,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showActionMenu(options: promptAction.ActionMenuOptions, callback: AsyncCallback): void; @@ -1176,7 +1247,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showActionMenu(options: promptAction.ActionMenuOptions): Promise; @@ -1195,9 +1267,10 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ - openCustomDialog(dialogContent: ComponentContent, options?: promptAction.BaseDialogOptions): Promise; + openCustomDialog(dialogContent: ComponentContent, options?: promptAction.BaseDialogOptions): Promise; /** * Open the custom dialog with frameNode and controller. @@ -1215,7 +1288,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ openCustomDialogWithController(dialogContent: ComponentContent, controller: promptAction.DialogController, options?: promptAction.BaseDialogOptions): Promise; @@ -1235,9 +1309,10 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ - updateCustomDialog(dialogContent: ComponentContent, options: promptAction.BaseDialogOptions): Promise; + updateCustomDialog(dialogContent: ComponentContent, options: promptAction.BaseDialogOptions): Promise; /** * Close the custom dialog with frameNode. @@ -1270,7 +1345,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ openCustomDialog(options: promptAction.CustomDialogOptions): Promise; @@ -1289,7 +1365,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ presentCustomDialog(builder: CustomBuilder | CustomBuilderWithId, controller?: promptAction.DialogController, options?: promptAction.DialogOptions): Promise; @@ -1306,7 +1383,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ closeCustomDialog(dialogId: number): void; @@ -1317,7 +1395,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ getTopOrder(): LevelOrder @@ -1328,7 +1407,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ getBottomOrder(): LevelOrder @@ -1350,7 +1430,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ openPopup(content: ComponentContent, target: TargetInfo, options?: PopupCommonOptions): Promise; @@ -1372,7 +1453,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ updatePopup(content: ComponentContent, options: PopupCommonOptions, partialUpdate?: boolean): Promise; @@ -1390,7 +1472,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ closePopup(content: ComponentContent): Promise; @@ -1412,7 +1495,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ openMenu(content: ComponentContent, target: TargetInfo, options?: MenuOptions): Promise; @@ -1434,7 +1518,8 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ updateMenu(content: ComponentContent, options: MenuOptions, partialUpdate?: boolean): Promise; @@ -1452,10 +1537,10 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ - closeMenu(content: ComponentContent): Promise; -} + closeMenu(content: ComponentContent): Promise;} /** * Defines the callback type used in UIObserver watch click event. @@ -1468,9 +1553,10 @@ export class PromptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -declare type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) => void; +type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) => void; /** * Defines the callback type used in UIObserver watch pan event. @@ -1484,9 +1570,10 @@ declare type ClickEventListenerCallback = (event: ClickEvent, node?: FrameNode) * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ -declare type PanListenerCallback = (event: GestureEvent, current: GestureRecognizer, node?: FrameNode) => void; +type PanListenerCallback = (event: GestureEvent, current: GestureRecognizer, node?: FrameNode) => void; /** * Defines the callback type used in UIObserver watch gesture. @@ -1499,9 +1586,10 @@ declare type PanListenerCallback = (event: GestureEvent, current: GestureRecogni * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -declare type GestureEventListenerCallback = (event: GestureEvent, node?: FrameNode) => void; +type GestureEventListenerCallback = (event: GestureEvent, node?: FrameNode) => void; /** * Defines the PageInfo type. @@ -1514,7 +1602,8 @@ declare type GestureEventListenerCallback = (event: GestureEvent, node?: FrameNo * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export interface PageInfo { /** @@ -1523,7 +1612,8 @@ export interface PageInfo { * @type { ?observer.RouterPageInfo } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ routerPageInfo?: observer.RouterPageInfo; @@ -1533,7 +1623,8 @@ export interface PageInfo { * @type { ?observer.NavDestinationInfo } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ navDestinationInfo?: observer.NavDestinationInfo; } @@ -1545,7 +1636,8 @@ export interface PageInfo { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ export interface OverlayManagerOptions { /** @@ -1556,7 +1648,8 @@ export interface OverlayManagerOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ renderRootOverlay?: boolean; @@ -1567,7 +1660,8 @@ export interface OverlayManagerOptions { * @default true * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ enableBackPressedEvent?: boolean; } @@ -1587,7 +1681,16 @@ export interface OverlayManagerOptions { * @atomicservice * @since 12 */ -export class UIObserver { +/** + * Register callbacks to observe ArkUI behavior. + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +export declare class UIObserver { /** * Registers a callback function to be called when the navigation destination is updated. * @@ -1611,6 +1714,24 @@ export class UIObserver { */ on(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback: Callback): void; + /** + * Registers a callback function to be called when the navigation destination is updated. + * + * @param { 'navDestinationUpdate' } type - The type of event to listen for. Must be 'navDestinationUpdate'. + * @param { observer.NavDestinationSwitchObserverOptions } options - The options object. + * @param { Callback } callback - The callback function to be called when the navigation destination is updated. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + on( + type: 'navDestinationUpdate', + options: observer.NavDestinationSwitchObserverOptions, + callback: Callback + ): void; + /** * Removes a callback function that was previously registered with `on()`. * @@ -1636,6 +1757,25 @@ export class UIObserver { */ off(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback?: Callback): void; + /** + * Removes a callback function that was previously registered with `on()`. + * + * @param { 'navDestinationUpdate' } type - The type of event to remove the listener for. Must be 'navDestinationUpdate'. + * @param { observer.NavDestinationSwitchObserverOptions } options - The options object. + * @param { Callback } callback - The callback function to remove. If not provided, all callbacks for the given event type and + * navigation ID will be removed. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + off( + type: 'navDestinationUpdate', + options: observer.NavDestinationSwitchObserverOptions, + callback?: Callback + ): void; + /** * Registers a callback function to be called when the navigation destination is updated. * @@ -1653,7 +1793,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'navDestinationUpdate', callback: Callback): void; @@ -1676,7 +1817,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'navDestinationUpdate', callback?: Callback): void; @@ -1689,7 +1831,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'scrollEvent', options: observer.ObserverOptions, callback: Callback): void; @@ -1703,7 +1846,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'scrollEvent', options: observer.ObserverOptions, callback?: Callback): void; @@ -1715,7 +1859,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'scrollEvent', callback: Callback): void; @@ -1728,7 +1873,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'scrollEvent', callback?: Callback): void; @@ -1749,7 +1895,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'routerPageUpdate', callback: Callback): void; @@ -1772,7 +1919,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'routerPageUpdate', callback?: Callback): void; @@ -1784,7 +1932,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'densityUpdate', callback: Callback): void; @@ -1797,7 +1946,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'densityUpdate', callback?: Callback): void; @@ -1809,7 +1959,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'willDraw', callback: Callback): void; @@ -1822,7 +1973,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'willDraw', callback?: Callback): void; @@ -1834,7 +1986,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'didLayout', callback: Callback): void; @@ -1847,7 +2000,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'didLayout', callback?: Callback): void; @@ -1860,7 +2014,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on( type: 'navDestinationSwitch', @@ -1876,7 +2031,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off( type: 'navDestinationSwitch', @@ -1893,7 +2049,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on( type: 'navDestinationSwitch', @@ -1911,7 +2068,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off( type: 'navDestinationSwitch', @@ -1928,7 +2086,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'willClick', callback: ClickEventListenerCallback): void; @@ -1941,7 +2100,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'willClick', callback?: ClickEventListenerCallback): void; @@ -1954,7 +2114,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'didClick', callback: ClickEventListenerCallback): void; @@ -1967,7 +2128,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'didClick', callback?: ClickEventListenerCallback): void; @@ -1980,7 +2142,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'willClick', callback: GestureEventListenerCallback): void; @@ -1993,7 +2156,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'willClick', callback?: GestureEventListenerCallback): void; @@ -2006,7 +2170,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'didClick', callback: GestureEventListenerCallback): void; @@ -2019,7 +2184,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'didClick', callback?: GestureEventListenerCallback): void; @@ -2032,7 +2198,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'beforePanStart', callback: PanListenerCallback): void; @@ -2045,7 +2212,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'beforePanStart', callback?: PanListenerCallback): void; @@ -2058,7 +2226,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'beforePanEnd', callback: PanListenerCallback): void; @@ -2071,7 +2240,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'beforePanEnd', callback?: PanListenerCallback): void; @@ -2084,7 +2254,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'afterPanStart', callback: PanListenerCallback): void; @@ -2097,7 +2268,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'afterPanStart', callback?: PanListenerCallback): void; @@ -2110,7 +2282,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'afterPanEnd', callback: PanListenerCallback): void; @@ -2123,7 +2296,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'afterPanEnd', callback?: PanListenerCallback): void; @@ -2137,7 +2311,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'tabContentUpdate', options: observer.ObserverOptions, callback: Callback): void; @@ -2151,7 +2326,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'tabContentUpdate', options: observer.ObserverOptions, callback?: Callback): void; @@ -2164,7 +2340,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'tabContentUpdate', callback: Callback): void; @@ -2177,7 +2354,8 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'tabContentUpdate', callback?: Callback): void; } @@ -2193,9 +2371,10 @@ export class UIObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ -export class ComponentUtils { +export declare class ComponentUtils { /** * Provide the ability to obtain the coordinates and size of component drawing areas. * @@ -2213,7 +2392,8 @@ export class ComponentUtils { * @throws { BusinessError } 100001 - UI execution context not found. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getRectangleById(id: string): componentUtils.ComponentInfo; } @@ -2223,9 +2403,10 @@ export class ComponentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class OverlayManager { +export declare class OverlayManager { /** * Add the ComponentContent to the OverlayManager. * @@ -2234,7 +2415,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ addComponentContent(content: ComponentContent, index?: number): void; @@ -2246,7 +2428,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ addComponentContentWithOrder(content: ComponentContent, levelOrder?: LevelOrder): void; @@ -2257,7 +2440,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ removeComponentContent(content: ComponentContent): void; @@ -2268,7 +2452,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ showComponentContent(content: ComponentContent): void; @@ -2279,7 +2464,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ hideComponentContent(content: ComponentContent): void; @@ -2289,7 +2475,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ showAllComponentContents(): void; @@ -2299,7 +2486,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ hideAllComponentContents(): void; } @@ -2317,7 +2505,8 @@ export class OverlayManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export interface AtomicServiceBar { /** @@ -2326,7 +2515,8 @@ export interface AtomicServiceBar { * @param { boolean } visible - whether this bar is visible. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ setVisible(visible: boolean): void; @@ -2343,7 +2533,8 @@ export interface AtomicServiceBar { * @param { Nullable< Color | number | string> } color - the color to set, undefined indicates using default. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setBackgroundColor(color: Nullable< Color | number | string>): void; @@ -2360,7 +2551,8 @@ export interface AtomicServiceBar { * @param { string } content - the content of the bar. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setTitleContent(content: string): void; @@ -2377,7 +2569,8 @@ export interface AtomicServiceBar { * @param { FontStyle } font - the font style of the bar's title. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setTitleFontStyle(font: FontStyle): void; @@ -2394,7 +2587,8 @@ export interface AtomicServiceBar { * @param { Nullable< Color | number | string> } color - the color to set to icon, undefined indicates using default. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setIconColor(color: Nullable< Color | number | string>): void; @@ -2405,7 +2599,8 @@ export interface AtomicServiceBar { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ getBarRect(): Frame; } @@ -2415,16 +2610,18 @@ export interface AtomicServiceBar { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class DynamicSyncScene { +export declare class DynamicSyncScene { /** * Sets the FrameRateRange of the DynamicSyncScene. * * @param { ExpectedFrameRateRange } range - The range of frameRate. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setFrameRateRange(range: ExpectedFrameRateRange): void; @@ -2434,7 +2631,8 @@ export class DynamicSyncScene { * @returns { ExpectedFrameRateRange } The range of frameRate. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getFrameRateRange(): ExpectedFrameRateRange; } @@ -2445,16 +2643,18 @@ export class DynamicSyncScene { * @extends DynamicSyncScene * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class SwiperDynamicSyncScene extends DynamicSyncScene { +export declare class SwiperDynamicSyncScene extends DynamicSyncScene { /** * Type of the SwiperDynamicSyncSceneType. * @type { SwiperDynamicSyncSceneType } * @readonly * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ readonly type: SwiperDynamicSyncSceneType; } @@ -2465,16 +2665,18 @@ export class SwiperDynamicSyncScene extends DynamicSyncScene { * @extends DynamicSyncScene * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ -export class MarqueeDynamicSyncScene extends DynamicSyncScene { +export declare class MarqueeDynamicSyncScene extends DynamicSyncScene { /** * Type of the MarqueeDynamicSyncSceneType. * @type { MarqueeDynamicSyncSceneType } * @readonly * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ readonly type: MarqueeDynamicSyncSceneType; } @@ -2495,9 +2697,10 @@ export class MarqueeDynamicSyncScene extends DynamicSyncScene { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ -export class DragController { +export declare class DragController { /** * Execute a drag event. * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. @@ -2541,7 +2744,8 @@ export class DragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo, callback: AsyncCallback): void; @@ -2586,7 +2790,8 @@ export class DragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: dragController.DragInfo) : Promise; @@ -2631,7 +2836,8 @@ export class DragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ createDragAction(customArray: Array, dragInfo: dragController.DragInfo): dragController.DragAction; @@ -2654,7 +2860,8 @@ export class DragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ getDragPreview(): dragController.DragPreview; @@ -2670,7 +2877,8 @@ export class DragController { * @param { boolean } enable - Indicating enable drag event strict reporting or not. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setDragEventStrictReportingEnabled(enable: boolean): void; @@ -2679,7 +2887,8 @@ export class DragController { * @param { dragController.DragStartRequestStatus } requestStatus - Status about the drag start behavior. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ notifyDragStartRequest(requestStatus: dragController.DragStartRequestStatus): void; @@ -2691,7 +2900,8 @@ export class DragController { * @throws { BusinessError } 190004 - Operation failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ cancelDataLoading(key: string): void; } @@ -2701,9 +2911,10 @@ export class DragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class MeasureUtils { +export declare class MeasureUtils { /** * Obtains the width of the specified text in a single line layout. * @@ -2712,7 +2923,8 @@ export class MeasureUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ measureText(options: MeasureOptions): number; @@ -2724,7 +2936,8 @@ export class MeasureUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ measureTextSize(options: MeasureOptions): SizeOptions; } @@ -2733,14 +2946,16 @@ export class MeasureUtils { * class FocusController * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ - export class FocusController { +export declare class FocusController { /** * clear focus to the root container. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ clearFocus(): void; @@ -2752,7 +2967,8 @@ export class MeasureUtils { * @throws { BusinessError } 150003 - the component is not on tree or does not exist. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ requestFocus(key: string): void; @@ -2763,7 +2979,8 @@ export class MeasureUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts { '1.1':'14','1.2':'20' } + * @arkts 1.1&1.2 */ activate(isActive: boolean, autoInactive?: boolean): void; @@ -2773,7 +2990,8 @@ export class MeasureUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts { '1.1':'14','1.2':'20' } + * @arkts 1.1&1.2 */ setAutoFocusTransfer(isAutoFocusTransfer: boolean): void; @@ -2783,7 +3001,8 @@ export class MeasureUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ setKeyProcessingMode(mode: KeyProcessingMode): void; } @@ -2794,7 +3013,8 @@ export class MeasureUtils { * @typedef {pointer.PointerStyle} PointerStyle * @syscap SystemCapability.MultimodalInput.Input.Pointer * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export type PointerStyle = pointer.PointerStyle; @@ -2804,16 +3024,18 @@ export type PointerStyle = pointer.PointerStyle; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class CursorController { +export declare class CursorController { /** * Restore default cursor. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ restoreDefault(): void; /** @@ -2823,7 +3045,8 @@ export class CursorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setCursor(value: PointerStyle): void; } @@ -2834,16 +3057,18 @@ export class CursorController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class ContextMenuController { +export declare class ContextMenuController { /** * Close context menu. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ close(): void; } @@ -2856,7 +3081,16 @@ export class ContextMenuController { * @atomicservice * @since 12 */ -export abstract class FrameCallback { +/** + * Class FrameCallback + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +export declare abstract class FrameCallback { /** * Call when a new display frame is being rendered. * @@ -2864,7 +3098,8 @@ export abstract class FrameCallback { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ onFrame(frameTimeInNano: number): void; @@ -2875,7 +3110,8 @@ export abstract class FrameCallback { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ onIdle(timeLeftInNano: number): void; } @@ -2889,7 +3125,8 @@ export abstract class FrameCallback { * @StageModelOnly * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export type Context = common.Context; @@ -2897,9 +3134,10 @@ export type Context = common.Context; * class ComponentSnapshot * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ -export class ComponentSnapshot { +export declare class ComponentSnapshot { /** * Get a component snapshot by component id. * @@ -2914,7 +3152,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ get(id: string, callback: AsyncCallback, options?: componentSnapshot.SnapshotOptions): void; @@ -2932,7 +3171,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ get(id: string, options?: componentSnapshot.SnapshotOptions): Promise; @@ -2954,7 +3194,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ createFromBuilder(builder: CustomBuilder, callback: AsyncCallback, delay?: number, checkImageStatus?: boolean, options?: componentSnapshot.SnapshotOptions): void; @@ -2977,7 +3218,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ createFromBuilder(builder: CustomBuilder, delay?: number, checkImageStatus?: boolean, options?: componentSnapshot.SnapshotOptions): Promise; @@ -2999,7 +3241,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getSync(id: string, options?: componentSnapshot.SnapshotOptions): image.PixelMap; @@ -3017,7 +3260,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ getWithUniqueId(uniqueId: number, options?: componentSnapshot.SnapshotOptions): Promise; @@ -3038,7 +3282,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ getSyncWithUniqueId(uniqueId: number, options?: componentSnapshot.SnapshotOptions): image.PixelMap; @@ -3060,7 +3305,8 @@ export class ComponentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ createFromComponent(content: ComponentContent, delay?: number, checkImageStatus?: boolean, options?: componentSnapshot.SnapshotOptions): Promise; @@ -3081,7 +3327,16 @@ export class ComponentSnapshot { * @atomicservice * @since 11 */ -export class UIContext { +/** + * class UIContext + * + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.1&1.2 + */ +export declare class UIContext { /** * get object font. * @@ -3097,7 +3352,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getFont(): Font; @@ -3116,7 +3372,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getMediaQuery(): MediaQuery; @@ -3133,7 +3390,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getUIInspector(): UIInspector; @@ -3148,7 +3406,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getFilteredInspectorTree(filters?: Array): string; @@ -3165,7 +3424,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getFilteredInspectorTreeById(id: string, depth: number, filters?: Array): string; @@ -3184,7 +3444,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getRouter(): Router; @@ -3203,7 +3464,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getPromptAction(): PromptAction; @@ -3220,7 +3482,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getComponentUtils(): ComponentUtils; @@ -3239,7 +3502,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getUIObserver(): UIObserver; @@ -3250,7 +3514,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getOverlayManager(): OverlayManager; @@ -3262,7 +3527,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ setOverlayManagerOptions(options: OverlayManagerOptions): boolean; @@ -3273,7 +3539,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ getOverlayManagerOptions(): OverlayManagerOptions; @@ -3302,7 +3569,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ createAnimator(options: AnimatorOptions): AnimatorResult; @@ -3318,7 +3586,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ createAnimator(options: AnimatorOptions | SimpleAnimatorOptions): AnimatorResult; @@ -3339,7 +3608,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ animateTo(value: AnimateParam, event: () => void): void; @@ -3358,7 +3628,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showAlertDialog(options: AlertDialogParamWithConfirm | AlertDialogParamWithButtons | AlertDialogParamWithOptions): void; @@ -3377,7 +3648,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showActionSheet(value: ActionSheetOptions): void; @@ -3396,7 +3668,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showDatePickerDialog(options: DatePickerDialogOptions): void; @@ -3415,7 +3688,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showTimePickerDialog(options: TimePickerDialogOptions): void; @@ -3434,7 +3708,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ showTextPickerDialog(options: TextPickerDialogOptions): void; @@ -3453,7 +3728,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ runScopedTask(callback: () => void): void; @@ -3464,7 +3740,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ setKeyboardAvoidMode(value: KeyboardAvoidMode): void; @@ -3474,7 +3751,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getKeyboardAvoidMode(): KeyboardAvoidMode; @@ -3485,7 +3763,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ setPixelRoundMode(mode: PixelRoundMode): void; @@ -3496,7 +3775,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ getPixelRoundMode(): PixelRoundMode; @@ -3508,7 +3788,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts { '1.1':'15','1.2':'20' } + * @arkts 1.1&1.2 */ dispatchKeyEvent(node: number | string, event: KeyEvent): boolean; @@ -3518,7 +3799,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ getAtomicServiceBar(): Nullable; @@ -3541,7 +3823,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ getDragController(): DragController; @@ -3551,7 +3834,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getMeasureUtils(): MeasureUtils; @@ -3572,7 +3856,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ keyframeAnimateTo(param: KeyframeAnimateParam, keyframes: Array): void; @@ -3581,7 +3866,8 @@ export class UIContext { * @returns { FocusController } the FocusController * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getFocusController(): FocusController; @@ -3593,7 +3879,8 @@ export class UIContext { * and the system will automatically insert transition animations for state changes caused by the closure function. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ animateToImmediately(param: AnimateParam, event: Callback): void; @@ -3605,7 +3892,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getFrameNodeById(id: string): FrameNode | null; @@ -3617,7 +3905,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getAttachedFrameNodeById(id: string): FrameNode | null; @@ -3629,7 +3918,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getFrameNodeByUniqueId(id: number): FrameNode | null; @@ -3643,7 +3933,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getPageInfoByUniqueId(id: number): PageInfo; @@ -3656,7 +3947,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getNavigationInfoByUniqueId(id: number): observer.NavigationInfo | undefined; @@ -3668,7 +3960,8 @@ export class UIContext { * set values less than 0 to 0 and values greater than 1 to 1. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ setDynamicDimming(id: string, value: number): void; @@ -3679,7 +3972,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getCursorController(): CursorController; @@ -3690,7 +3984,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getContextMenuController(): ContextMenuController; @@ -3699,7 +3994,8 @@ export class UIContext { * @returns { ComponentSnapshot } the ComponentSnapshot * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getComponentSnapshot(): ComponentSnapshot; @@ -3709,7 +4005,8 @@ export class UIContext { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ vp2px(value: number): number; @@ -3719,7 +4016,8 @@ export class UIContext { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ px2vp(value: number): number; @@ -3729,7 +4027,8 @@ export class UIContext { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ fp2px(value: number): number; @@ -3739,7 +4038,8 @@ export class UIContext { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ px2fp(value: number): number; @@ -3749,7 +4049,8 @@ export class UIContext { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ lpx2px(value: number): number; @@ -3759,7 +4060,8 @@ export class UIContext { * @returns { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ px2lpx(value: number): number; @@ -3771,7 +4073,8 @@ export class UIContext { * @stagemodelonly * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getSharedLocalStorage(): LocalStorage | undefined; @@ -3783,7 +4086,8 @@ export class UIContext { * @stagemodelonly * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getHostContext(): Context | undefined; @@ -3794,7 +4098,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ getWindowName(): string | undefined; @@ -3804,7 +4109,8 @@ export class UIContext { * @returns { WidthBreakpoint } The width breakpoint of current window. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ getWindowWidthBreakpoint(): WidthBreakpoint; @@ -3814,7 +4120,8 @@ export class UIContext { * @returns { HeightBreakpoint } The height breakpoint of current window. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ getWindowHeightBreakpoint(): HeightBreakpoint; @@ -3837,7 +4144,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ openBindSheet(bindSheetContent: ComponentContent, sheetOptions?: SheetOptions, targetId?: number): Promise; @@ -3859,7 +4167,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ updateBindSheet(bindSheetContent: ComponentContent, sheetOptions: SheetOptions, partialUpdate?: boolean): Promise; @@ -3877,7 +4186,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ closeBindSheet(bindSheetContent: ComponentContent): Promise; @@ -3887,7 +4197,8 @@ export class UIContext { * @param { FrameCallback } frameCallback - The frame callback to run on the next frame. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ postFrameCallback(frameCallback: FrameCallback): void; @@ -3898,7 +4209,8 @@ export class UIContext { * @param { number } delayTime - The delay time in milliseconds, * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ postDelayedFrameCallback(frameCallback: FrameCallback, delayTime: number): void; @@ -3909,7 +4221,8 @@ export class UIContext { * @returns { Array} The instance of SwiperDynamicSyncScene. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ requireDynamicSyncScene(id: string): Array; @@ -3930,7 +4243,8 @@ export class UIContext { * @throws { BusinessError } 202 - The caller is not a system application. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ clearResourceCache(): void; @@ -3941,7 +4255,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ isFollowingSystemFontScale(): boolean; @@ -3952,7 +4267,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ getMaxFontScale(): number; @@ -3964,7 +4280,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ bindTabsToScrollable(tabsController: TabsController, scroller: Scroller): void; @@ -3976,7 +4293,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ unbindTabsFromScrollable(tabsController: TabsController, scroller: Scroller): void; @@ -3989,7 +4307,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ bindTabsToNestedScrollable(tabsController: TabsController, parentScroller: Scroller, childScroller: Scroller): void; @@ -4002,7 +4321,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 13 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ unbindTabsFromNestedScrollable(tabsController: TabsController, parentScroller: Scroller, childScroller: Scroller): void; @@ -4012,7 +4332,8 @@ export class UIContext { * @param { Optional } enabled - enable or disable swipe to back event. * @syscap SystemCapability.ArkUI.ArkUI.Circle * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ enableSwipeBack(enabled: Optional): void; @@ -4024,7 +4345,8 @@ export class UIContext { * @throws { BusinessError } 202 - The caller is not a system application. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ freezeUINode(id: string, isFrozen: boolean): void; @@ -4036,7 +4358,8 @@ export class UIContext { * @throws { BusinessError } 202 - The caller is not a system application. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ freezeUINode(uniqueId: number, isFrozen: boolean): void; @@ -4047,7 +4370,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts { '1.1':'16','1.2':'20' } + * @arkts 1.1&1.2 */ getTextMenuController(): TextMenuController; @@ -4062,7 +4386,8 @@ export class UIContext { * @throws { BusinessError } 100001 - Internal error. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ static createUIContextWithoutWindow(context: common.UIAbilityContext | common.ExtensionContext) : UIContext | undefined; @@ -4071,7 +4396,8 @@ export class UIContext { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts { '1.1':'18','1.2':'20' } + * @arkts 1.1&1.2 */ static destroyUIContextWithoutWindow(): void; } @@ -4083,7 +4409,8 @@ export class UIContext { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ export const enum KeyboardAvoidMode { @@ -4092,7 +4419,8 @@ export const enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ OFFSET = 0, @@ -4101,7 +4429,8 @@ export const enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts { '1.1':'11','1.2':'20' } + * @arkts 1.1&1.2 */ RESIZE = 1, @@ -4110,7 +4439,8 @@ export const enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts { '1.1':'14','1.2':'20' } + * @arkts 1.1&1.2 */ OFFSET_WITH_CARET = 2, @@ -4119,7 +4449,8 @@ export const enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts { '1.1':'14','1.2':'20' } + * @arkts 1.1&1.2 */ RESIZE_WITH_CARET = 3, @@ -4128,7 +4459,8 @@ export const enum KeyboardAvoidMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts { '1.1':'14','1.2':'20' } + * @arkts 1.1&1.2 */ NONE = 4, } @@ -4139,7 +4471,8 @@ export const enum KeyboardAvoidMode { * @enum { number } SwiperDynamicSyncSceneType * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export const enum SwiperDynamicSyncSceneType { /** @@ -4147,7 +4480,8 @@ export const enum SwiperDynamicSyncSceneType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ GESTURE = 0, @@ -4156,7 +4490,8 @@ export const enum SwiperDynamicSyncSceneType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ ANIMATION = 1 } @@ -4167,7 +4502,8 @@ export const enum SwiperDynamicSyncSceneType { * @enum { number } MarqueeDynamicSyncSceneType * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ export const enum MarqueeDynamicSyncSceneType { /** @@ -4175,7 +4511,8 @@ export const enum MarqueeDynamicSyncSceneType { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts { '1.1':'13','1.2':'20' } + * @arkts 1.1&1.2 */ ANIMATION = 1 } @@ -4186,16 +4523,18 @@ export const enum MarqueeDynamicSyncSceneType { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts { '1.1':'16','1.2':'20' } + * @arkts 1.1&1.2 */ -export class TextMenuController { +export declare class TextMenuController { /** * Set text menu options. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 16 + * @since arkts { '1.1':'16','1.2':'20' } + * @arkts 1.1&1.2 */ setMenuOptions(options: TextMenuOptions): void; } diff --git a/api/@ohos.arkui.advanced.GridObjectSortComponent.d.ets b/api/@ohos.arkui.advanced.GridObjectSortComponent.d.ets index 1818bd2488a5b89857ff28c9b30be2550642a784..0d5a7d2ea674e58d6cceea5b238bd12238752825 100644 --- a/api/@ohos.arkui.advanced.GridObjectSortComponent.d.ets +++ b/api/@ohos.arkui.advanced.GridObjectSortComponent.d.ets @@ -18,14 +18,21 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource, ResourceStr, ResourceColor, LocalizedMargin } from './arkui/component/units'; +import { Prop } from './arkui/stateManagement/common'; +import { Component } from './arkui/component/customComponent'; +/*** endif */ + /** * Controls the style types of GridObjectSortComponent. * @enum { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** +/** * Controls the style types of GridObjectSortComponent. * @enum { string } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -38,9 +45,10 @@ export declare enum GridObjectSortComponentType { * The GridObjectSortComponent image text type. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * The GridObjectSortComponent image text type. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -53,9 +61,10 @@ export declare enum GridObjectSortComponentType { * The GridObjectSortComponent text type. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * The GridObjectSortComponent text type. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform @@ -70,9 +79,10 @@ export declare enum GridObjectSortComponentType { * @interface GridObjectSortComponentIteml * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** +/** * Declaration of the GridObjectSortComponent item. * @interface GridObjectSortComponentIteml * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -86,9 +96,10 @@ export interface GridObjectSortComponentItem { * @type { number | string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * id of GridObjectSortComponent item. * @type { number | string } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -103,9 +114,10 @@ export interface GridObjectSortComponentItem { * @type { ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * GridObjectSortComponent item text. * @type { ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -120,9 +132,10 @@ export interface GridObjectSortComponentItem { * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * selected of GridObjectSortComponent item, true is show area, false is add area. * @type { boolean } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -137,9 +150,10 @@ export interface GridObjectSortComponentItem { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * order of GridObjectSortComponentItem, Used for sorting dataList. * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -154,9 +168,10 @@ export interface GridObjectSortComponentItem { * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * image resource path of the GridObjectSortComponent item. * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -181,9 +196,10 @@ export interface GridObjectSortComponentItem { * @interface GridEditOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** +/** * GridObjectSortComponentOptions of GridObjectSortComponent. * @interface GridEditOptions * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -198,9 +214,10 @@ export interface GridObjectSortComponentOptions { * @default GridObjectSortComponentType.TEXT * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Configuration GridObjectSortComponent type. * @type { GridObjectSortComponentType } * @default GridObjectSortComponentType.TEXT @@ -216,9 +233,10 @@ export interface GridObjectSortComponentOptions { * @type { ?number | ?Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * The size of the GridObjectSortComponent image. * @type { ?number | ?Resource } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -233,9 +251,10 @@ export interface GridObjectSortComponentOptions { * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * The title displayed in the unedited state of the GridObjectSortComponent. * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -250,9 +269,10 @@ export interface GridObjectSortComponentOptions { * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * The title displayed in the GridObjectSortComponent edit state. * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -267,9 +287,10 @@ export interface GridObjectSortComponentOptions { * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Display Area Title, First subtitle of the GridObjectSortComponent. * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -284,9 +305,10 @@ export interface GridObjectSortComponentOptions { * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Add Zone Title, second subtitle of the GridObjectSortComponent. * @type { ?ResourceStr } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -302,9 +324,10 @@ export interface GridObjectSortComponentOptions { * @struct { GridObjectSortComponent } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** +/** * Declare struct GridObjectSortComponent. * @struct { GridObjectSortComponent } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -319,9 +342,10 @@ export declare struct GridObjectSortComponent { * @type { GridObjectSortComponentOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Component types and parameters of the GridObjectSortComponent. * @type { GridObjectSortComponentOptions } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -331,15 +355,15 @@ export declare struct GridObjectSortComponent { */ @Prop options: GridObjectSortComponentOptions; - /** * Data list of GridObjectSortComponent. * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Data list of GridObjectSortComponent. * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -348,15 +372,15 @@ export declare struct GridObjectSortComponent { * @since 12 */ dataList: Array; - /** * Callback when Obtain edited data. * @type { (select: Array, unselect: Array) => void } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Callback when Obtain edited data. * @type { (select: Array, unselect: Array) => void } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -365,15 +389,15 @@ export declare struct GridObjectSortComponent { * @since 12 */ onSave: (select: Array, unselect: Array) => void; - /** * Cancel callback for saving data. * @type { () => void } * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Cancel callback for saving data. * @type { () => void } * @syscap SystemCapability.ArkUI.ArkUI.Full @@ -387,9 +411,10 @@ export declare struct GridObjectSortComponent { * Build function of GridObjectSortComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - /** + /** * Build function of GridObjectSortComponent. * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform diff --git a/api/@ohos.arkui.advanced.SubHeader.d.ets b/api/@ohos.arkui.advanced.SubHeader.d.ets index 3bc64397e0aa6135f35bd851bdbfa2d5c8c35187..6e0352f669e3263100895b7ea7c1fe8180a59c5f 100644 --- a/api/@ohos.arkui.advanced.SubHeader.d.ets +++ b/api/@ohos.arkui.advanced.SubHeader.d.ets @@ -20,6 +20,14 @@ import { TextModifier } from './@ohos.arkui.modifier'; +/*** if arkts 1.2 */ +import { Resource, ResourceStr, ResourceColor, LocalizedPadding, LocalizedMargin } from './arkui/component/units'; +import { SymbolEffectStrategy, SymbolRenderingStrategy } from './arkui/component/symbolglyph'; +import { SelectOption } from './arkui/component/select'; +import { Prop, BuilderParam } from './arkui/stateManagement/common'; +import { Component } from './arkui/component/customComponent'; +import { FontWeight } from './arkui/component/enums'; +/*** endif */ /** * Control style of operation element @@ -32,7 +40,8 @@ import { TextModifier } from './@ohos.arkui.modifier'; * @enum { OperationStyle } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Control style of operation element @@ -52,7 +61,8 @@ export declare enum OperationType { * The TextArrow style. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The TextArrow style. @@ -72,7 +82,8 @@ export declare enum OperationType { * The Button style. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The Button style. @@ -92,7 +103,8 @@ export declare enum OperationType { * The IconGroup style. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The IconGroup style. @@ -112,7 +124,8 @@ export declare enum OperationType { * The LoadingProgress style. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The LoadingProgress style. @@ -133,7 +146,8 @@ export declare enum OperationType { * Declare type OperationOption * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Declare type OperationOption @@ -154,7 +168,8 @@ export declare class OperationOption { * @type { ResourceStr }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The content of text or the address of icon. @@ -165,7 +180,6 @@ export declare class OperationOption { * @since 18 */ value: ResourceStr; - /** * callback function when operate the text or icon. * @type { () => void }. @@ -177,7 +191,8 @@ export declare class OperationOption { * @type { () => void }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * callback function when operate the text or icon. @@ -188,7 +203,6 @@ export declare class OperationOption { * @since 18 */ action?: () => void; - /** * The accessibilityText of this text or icon. * @type { ?ResourceStr }. @@ -197,7 +211,6 @@ export declare class OperationOption { * @since 18 */ accessibilityText?: ResourceStr; - /** * The accessibilityDescription of this text or icon. * @type { ?ResourceStr } @@ -206,7 +219,6 @@ export declare class OperationOption { * @since 18 */ accessibilityDescription?: ResourceStr; - /** * The accessibilityLevel of this text or icon. * @type { ?string } @@ -216,7 +228,6 @@ export declare class OperationOption { * @since 18 */ accessibilityLevel?: string; - /** * Sets the default focus state of the text or icon. * @type { ?boolean }. @@ -237,7 +248,8 @@ export declare class OperationOption { * Declare type SelectOption * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Declare type SelectOption @@ -258,7 +270,8 @@ export declare class SelectOptions { * @type { Array }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * SubOption array of the select. @@ -269,7 +282,6 @@ export declare class SelectOptions { * @since 18 */ options: Array; - /** * The default selected index. * @type { number }. @@ -281,7 +293,8 @@ export declare class SelectOptions { * @type { number }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The default selected index. @@ -292,7 +305,6 @@ export declare class SelectOptions { * @since 18 */ selected?: number; - /** * The default text value. * @type { string }. @@ -304,7 +316,8 @@ export declare class SelectOptions { * @type { string }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The default text value. @@ -315,30 +328,29 @@ export declare class SelectOptions { * @since 18 */ value?: string; - - /** - * Callback when the select is selected. - * @type { (index: number, value?: string) => void }. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 10 - */ - /** - * Callback when the select is selected. - * @type { (index: number, value?: string) => void }. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @atomicservice - * @since 11 - */ - /** - * Callback when the select is selected. - * @type { (index: number, value?: string) => void }. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ + /** + * Callback when the select is selected. + * @type { (index: number, value?: string) => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @since 10 + */ + /** + * Callback when the select is selected. + * @type { (index: number, value?: string) => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 + */ + /** + * Callback when the select is selected. + * @type { (index: number, value?: string) => void }. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 18 + */ onSelect?: (index: number, value?: string) => void; - /** * Sets the default focus state of select. * @type { ?boolean }. @@ -354,14 +366,14 @@ export declare class SelectOptions { * Declare type SymbolOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since 12 */ - /** +/** * Declare type SymbolOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since 18 */ export declare class SymbolOptions { /** @@ -380,7 +392,6 @@ export declare class SymbolOptions { * @since 18 */ fontSize?: number | string | Resource; - /** * The color of symbol icon. * @type { ?(Array) }. @@ -397,7 +408,6 @@ export declare class SymbolOptions { * @since 18 */ fontColor?: Array; - /** * The fontWeight of symbol icon. * @type { ?(number | FontWeight | string) }. @@ -414,7 +424,6 @@ export declare class SymbolOptions { * @since 18 */ fontWeight?: number | FontWeight | string; - /** * The effect strategy of symbol icon. * @type { ?(SymbolEffectStrategy) }. @@ -431,7 +440,6 @@ export declare class SymbolOptions { * @since 18 */ effectStrategy?: SymbolEffectStrategy; - /** * The rendering strategy of symbol icon. * @type { ?(SymbolRenderingStrategy) }. @@ -459,7 +467,8 @@ export declare class SymbolOptions { * Declare struct SubHeader * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Declare struct SubHeader @@ -470,7 +479,6 @@ export declare class SymbolOptions { */ @Component export declare struct SubHeader { - /** * Icon resource of content area. * @type { ResourceStr }. @@ -482,7 +490,8 @@ export declare struct SubHeader { * @type { ResourceStr }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Icon resource of content area. @@ -493,7 +502,6 @@ export declare struct SubHeader { * @since 18 */ @Prop icon?: ResourceStr; - /** * Attributes of Symbol icon. * @type { SymbolOptions}. @@ -509,7 +517,6 @@ export declare struct SubHeader { * @since 18 */ iconSymbolOptions?: SymbolOptions; - /** * The first line text of content area. * @type { ResourceStr }. @@ -521,7 +528,8 @@ export declare struct SubHeader { * @type { ResourceStr }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The first line text of content area. @@ -532,7 +540,6 @@ export declare struct SubHeader { * @since 18 */ @Prop primaryTitle?: ResourceStr; - /** * The secondary line text of content area. * @type { ResourceStr }. @@ -544,7 +551,8 @@ export declare struct SubHeader { * @type { ResourceStr }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * The secondary line text of content area. @@ -555,7 +563,6 @@ export declare struct SubHeader { * @since 18 */ @Prop secondaryTitle?: ResourceStr; - /** * Select option of content area. * @type { SelectOptions }. @@ -567,7 +574,8 @@ export declare struct SubHeader { * @type { SelectOptions }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Select option of content area. @@ -578,7 +586,6 @@ export declare struct SubHeader { * @since 18 */ select?: SelectOptions; - /** * Operation style of SubHeader. * @type { OperationStyle }. @@ -590,7 +597,8 @@ export declare struct SubHeader { * @type { OperationStyle }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * Operation style of SubHeader. @@ -601,7 +609,6 @@ export declare struct SubHeader { * @since 18 */ @Prop operationType?: OperationType; - /** * operation item. * @type { Array }. @@ -613,7 +620,8 @@ export declare struct SubHeader { * @type { Array }. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ /** * operation item. @@ -624,7 +632,6 @@ export declare struct SubHeader { * @since 18 */ operationItem?: Array; - /** * Attributes of Symbol icons in operation area. * @type { Array }. @@ -640,7 +647,6 @@ export declare struct SubHeader { * @since 18 */ operationSymbolOptions?: Array; - /** * Text modifier for primary title. * @type { TextModifier }. @@ -657,7 +663,6 @@ export declare struct SubHeader { * @since 18 */ primaryTitleModifier?: TextModifier; - /** * Text modifier for secondary title. * @type { TextModifier }. @@ -674,7 +679,6 @@ export declare struct SubHeader { * @since 18 */ secondaryTitleModifier?: TextModifier; - /** * Set the title content. * @type { () => void } @@ -691,7 +695,6 @@ export declare struct SubHeader { * @since 18 */ @BuilderParam titleBuilder?: () => void; - /** * Set the content margin. * @type { ?LocalizedMargin } @@ -712,7 +715,6 @@ export declare struct SubHeader { * @since 18 */ @Prop contentMargin?: LocalizedMargin; - /** * Set the content padding. * @type { ?LocalizedPadding } diff --git a/api/@ohos.arkui.component.d.ets b/api/@ohos.arkui.component.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..39aa286fd7952723169ac817366b26f475e3375c --- /dev/null +++ b/api/@ohos.arkui.component.d.ets @@ -0,0 +1,157 @@ +/* + * Copyright (C) 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 + * @arkts 1.2 + */ + +export * from './arkui/UserView'; +export * from './arkui/component/animation'; +export * from './arkui/component/customComponent'; +export * from './arkui/component/common'; +export * from './arkui/component/column'; +export * from './arkui/component/text'; +export * from './arkui/component/styledString'; +export * from './arkui/component/enums'; +export * from './arkui/component/units'; +export * from './arkui/component/actionSheet'; +export * from './arkui/component/alertDialog'; +export * from './arkui/component/alphabetIndexer'; +export * from './arkui/component/animator'; +export * from './arkui/component/badge'; +export * from './arkui/component/blank'; +export * from './arkui/component/builder'; +export * from './arkui/component/button'; +export * from './arkui/component/calendar'; +export * from './arkui/component/calendarPicker'; +export * from './arkui/component/canvas'; +export * from './arkui/component/checkbox'; +export * from './arkui/component/checkboxgroup'; +export * from './arkui/component/circle'; +export * from './arkui/component/column'; +export * from './arkui/component/columnSplit'; +export * from './arkui/component/common'; +export * from './arkui/component/containerSpan'; +export * from './arkui/component/contentSlot'; +export * from './arkui/component/counter'; +export * from './arkui/component/customComponent'; +export * from './arkui/component/customDialogController'; +export * from './arkui/component/dataPanel'; +export * from './arkui/component/datePicker'; +export * from './arkui/component/divider'; +export * from './arkui/component/effectComponent'; +export * from './arkui/component/ellipse'; +export * from './arkui/component/embeddedComponent'; +export * from './arkui/component/enums'; +export * from './arkui/component/extendableComponent'; +export * from './arkui/component/flex'; +export * from './arkui/component/flowItem'; +export * from './arkui/component/focus'; +export * from './arkui/component/folderStack'; +export * from './arkui/component/forEach'; +export * from './arkui/component/formComponent'; +export * from './arkui/component/formLink'; +export * from './arkui/component/gauge'; +export * from './arkui/component/gesture'; +export * from './arkui/component/grid'; +export * from './arkui/component/gridCol'; +export * from './arkui/component/gridRow'; +export * from './arkui/component/gridItem'; +export * from './arkui/component/hyperlink'; +export * from './arkui/component/image'; +export * from './arkui/component/imageAnimator'; +export * from './arkui/component/imageCommon'; +export * from './arkui/component/imageSpan'; +export * from './arkui/component/indicatorcomponent'; +export * from './arkui/component/inspector'; +export * from './arkui/component/interop'; +export * from './arkui/component/lazyForEach'; +export * from './arkui/component/line'; +export * from './arkui/component/linearindicator'; +export * from './arkui/component/list'; +export * from './arkui/component/listItem'; +export * from './arkui/component/listItemGroup'; +export * from './arkui/component/loadingProgress'; +export * from './arkui/component/marquee'; +export * from './arkui/component/matrix2d'; +export * from './arkui/component/mediaCachedImage'; +export * from './arkui/component/menu'; +export * from './arkui/component/menuItem'; +export * from './arkui/component/menuItemGroup'; +export * from './arkui/component/navDestination'; +export * from './arkui/component/navigation'; +export * from './arkui/component/nodeContainer'; +export * from './arkui/component/particle'; +export * from './arkui/component/pasteButton'; +export * from './arkui/component/path'; +export * from './arkui/component/patternLock'; +export * from './arkui/component/pluginComponent'; +export * from './arkui/component/polygon'; +export * from './arkui/component/polyline'; +export * from './arkui/component/progress'; +export * from './arkui/component/qrcode'; +export * from './arkui/component/radio'; +export * from './arkui/component/rating'; +export * from './arkui/component/rect'; +export * from './arkui/component/refresh'; +export * from './arkui/component/relativeContainer'; +export * from './arkui/component/remoteWindow'; +export * from './arkui/component/repeat'; +export * from './arkui/component/richEditor'; +export * from './arkui/component/richText'; +export * from './arkui/component/rootScene'; +export * from './arkui/component/row'; +export * from './arkui/component/rowSplit'; +export * from './arkui/component/saveButton'; +export * from './arkui/component/screen'; +export * from './arkui/component/scroll'; +export * from './arkui/component/scrollBar'; +export * from './arkui/component/search'; +export * from './arkui/component/securityComponent'; +export * from './arkui/component/select'; +export * from './arkui/component/shape'; +export * from './arkui/component/sidebar'; +export * from './arkui/component/slider'; +export * from './arkui/component/span'; +export * from './arkui/component/stack'; +export * from './arkui/component/stateManagement'; +export * from './arkui/component/stepper'; +export * from './arkui/component/stepperItem'; +export * from './arkui/component/styledString'; +export * from './arkui/component/swiper'; +export * from './arkui/component/symbolSpan'; +export * from './arkui/component/symbolglyph'; +export * from './arkui/component/tabContent'; +export * from './arkui/component/tabs'; +export * from './arkui/component/text'; +export * from './arkui/component/textArea'; +export * from './arkui/component/textClock'; +export * from './arkui/component/textCommon'; +export * from './arkui/component/textInput'; +export * from './arkui/component/textPicker'; +export * from './arkui/component/textTimer'; +export * from './arkui/component/timePicker'; +export * from './arkui/component/toggle'; +export * from './arkui/component/uiExtensionComponent'; +export * from './arkui/component/units'; +export * from './arkui/component/video'; +export * from './arkui/component/waterFlow'; +export * from './arkui/component/web'; +export * from './arkui/component/windowScene'; +export * from './arkui/component/withTheme'; +export * from './arkui/component/xcomponent'; +export * from './arkui/component/resources'; diff --git a/api/@ohos.arkui.componentSnapshot.d.ts b/api/@ohos.arkui.componentSnapshot.d.ts index bbb183f6ddf63287b1a01f0ff4dae8d7a7adb909..88fbb4e9ee60a621b1e9121421f66eee071e8295 100644 --- a/api/@ohos.arkui.componentSnapshot.d.ts +++ b/api/@ohos.arkui.componentSnapshot.d.ts @@ -18,6 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { CustomBuilder } from './arkui/component/builder' +/*** endif */ + import { AsyncCallback } from './@ohos.base'; import image from './@ohos.multimedia.image' @@ -36,7 +40,8 @@ import image from './@ohos.multimedia.image' * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace componentSnapshot { /** @@ -46,9 +51,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - interface SnapshotRegion { + export interface SnapshotRegion { /** * Left side position of rectangle, in PX. * @@ -56,7 +62,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ left: number; @@ -67,7 +74,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ right: number; @@ -78,7 +86,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ top: number; @@ -89,7 +98,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ bottom: number; } @@ -102,9 +112,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - interface LocalizedSnapshotRegion { + export interface LocalizedSnapshotRegion { /** * Left/Right side position of rectangle, in PX * @@ -112,7 +123,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ start: number; @@ -123,7 +135,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ end: number; @@ -134,7 +147,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ top: number; @@ -145,7 +159,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ bottom: number; } @@ -157,9 +172,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - type SnapshotRegionType = SnapshotRegion | LocalizedSnapshotRegion; + export type SnapshotRegionType = SnapshotRegion | LocalizedSnapshotRegion; /** * Defines the extra options for snapshot taking. @@ -168,9 +184,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface SnapshotOptions { + export interface SnapshotOptions { /** * Defines the scale property to render the snapshot. * @@ -178,7 +195,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scale?: number @@ -189,7 +207,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ waitUntilRenderFinished?: boolean @@ -200,7 +219,8 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ region?: SnapshotRegionType } @@ -233,9 +253,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.ComponentSnapshot#get + * @arkts 1.1&1.2 */ function get(id: string, callback: AsyncCallback, options?: SnapshotOptions): void; @@ -267,9 +288,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.ComponentSnapshot#get + * @arkts 1.1&1.2 */ function get(id: string, options?: SnapshotOptions): Promise; @@ -305,9 +327,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.ComponentSnapshot#createFromBuilder + * @arkts 1.1&1.2 */ function createFromBuilder(builder: CustomBuilder, callback: AsyncCallback, delay?: number, checkImageStatus?: boolean, options?: SnapshotOptions): void; @@ -344,9 +367,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.ComponentSnapshot#createFromBuilder + * @arkts 1.1&1.2 */ function createFromBuilder(builder: CustomBuilder, delay?: number, checkImageStatus?: boolean, options?: SnapshotOptions): Promise; @@ -368,9 +392,10 @@ declare namespace componentSnapshot { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - function getSync(id: string, options?: SnapshotOptions): image.PixelMap; + export function getSync(id: string, options?: SnapshotOptions): image.PixelMap; } export default componentSnapshot; diff --git a/api/@ohos.arkui.componentUtils.d.ts b/api/@ohos.arkui.componentUtils.d.ts index 32658420dca159b505dcfb4717f7f95fb6b865ed..5f2b6268df7841b1c25d4b4b01f67dd361d7d6b0 100644 --- a/api/@ohos.arkui.componentUtils.d.ts +++ b/api/@ohos.arkui.componentUtils.d.ts @@ -37,7 +37,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace componentUtils { @@ -60,9 +61,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface ComponentInfo { + export interface ComponentInfo { /** * component size. @@ -83,7 +85,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size: Size @@ -106,7 +109,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ localOffset: Offset @@ -129,7 +133,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ windowOffset: Offset @@ -152,7 +157,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ screenOffset: Offset @@ -175,7 +181,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ translate: TranslateResult @@ -198,7 +205,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scale: ScaleResult @@ -221,7 +229,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rotate: RotateResult @@ -244,7 +253,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transform: Matrix4Result } @@ -268,9 +278,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface Size { + export interface Size { /** * Defines the width property. @@ -291,7 +302,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number @@ -314,7 +326,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height: number } @@ -338,9 +351,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface Offset { + export interface Offset { /** * Coordinate x of the Position. @@ -361,7 +375,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number @@ -384,7 +399,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number } @@ -408,9 +424,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface TranslateResult { + export interface TranslateResult { /** * Indicates the translation distance of the x-axis, in vp. @@ -431,7 +448,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number @@ -454,7 +472,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number @@ -477,7 +496,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ z: number } @@ -501,9 +521,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface ScaleResult { + export interface ScaleResult { /** * Zoom factor of the x-axis. @@ -524,7 +545,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number @@ -547,7 +569,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number @@ -570,7 +593,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ z: number @@ -593,7 +617,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ centerX: number @@ -616,7 +641,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ centerY: number } @@ -640,9 +666,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - interface RotateResult { + export interface RotateResult { /** * Axis of rotation vector x coordinate. @@ -663,7 +690,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number @@ -686,7 +714,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number @@ -709,7 +738,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ z: number @@ -732,7 +762,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ centerX: number @@ -755,7 +786,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ centerY: number @@ -778,7 +810,8 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ angle: number } @@ -802,9 +835,10 @@ declare namespace componentUtils { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - type Matrix4Result = [ + export type Matrix4Result = [ number, number, number, diff --git a/api/@ohos.arkui.dragController.d.ts b/api/@ohos.arkui.dragController.d.ts index 9d94a33e049162c2f1351016b7da131fc178bdce..709e79ec1c244065764d8ae397289e52b5fe0770 100644 --- a/api/@ohos.arkui.dragController.d.ts +++ b/api/@ohos.arkui.dragController.d.ts @@ -18,10 +18,15 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { DragEvent, DragPreviewOptions, DragItemInfo, ICurve } from './arkui/component/common'; +import { CustomBuilder } from './arkui/component/builder' +import { TouchPoint, ResourceColor } from './arkui/component/units'; +import { Curve } from './arkui/component/enums'; +/*** endif */ - -import type { AsyncCallback, BusinessError, Callback } from './@ohos.base'; -import type unifiedDataChannel from './@ohos.data.unifiedDataChannel'; +import { AsyncCallback, BusinessError, Callback } from './@ohos.base'; +import unifiedDataChannel from './@ohos.data.unifiedDataChannel'; /** * This module allows developers to trigger a drag event. @@ -42,7 +47,8 @@ import type unifiedDataChannel from './@ohos.data.unifiedDataChannel'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace dragController { /** @@ -67,7 +73,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ const enum DragStatus { /** @@ -86,7 +93,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ STARTED = 0, /** @@ -105,7 +113,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ENDED = 1, } @@ -132,7 +141,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface DragAndDropInfo { /** @@ -154,7 +164,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ status: DragStatus; /** @@ -176,7 +187,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ event: DragEvent; /** @@ -198,7 +210,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ extraParams?: string; } @@ -225,7 +238,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface DragAction { /** @@ -253,7 +267,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ startDrag(): Promise; /** @@ -284,7 +299,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'statusChange', callback: Callback): void; @@ -316,7 +332,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'statusChange', callback?: Callback): void; } @@ -343,7 +360,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface DragInfo { /** @@ -365,7 +383,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ pointerId: number; @@ -388,7 +407,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ data?: unifiedDataChannel.UnifiedData; @@ -411,7 +431,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ extraParams?: string; @@ -434,7 +455,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ touchPoint?: TouchPoint; @@ -457,7 +479,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ previewOptions?: DragPreviewOptions; } @@ -484,7 +507,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface AnimationOptions { /** @@ -506,7 +530,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; /** @@ -528,7 +553,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ curve?: Curve | ICurve; } @@ -549,7 +575,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export class DragPreview { /** @@ -571,7 +598,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ setForegroundColor(color: ResourceColor): void; /** @@ -596,7 +624,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ animate(options: AnimationOptions, handler: () =>void): void; } @@ -616,7 +645,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface DragEventParam { @@ -639,7 +669,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ event: DragEvent; @@ -662,7 +693,8 @@ declare namespace dragController { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ extraParams: string; } @@ -692,24 +724,10 @@ declare namespace dragController { * @throws { BusinessError } 100001 - Internal handling failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 - */ - /** - * Execute a drag event. - * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. - * @param { DragInfo } dragInfo - Information about the drag event. - * @param { AsyncCallback } callback - Callback that contains the drag event information. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - Internal handling failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.DragController#executeDrag + * @arkts 1.1&1.2 */ function executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: DragInfo, callback: AsyncCallback): void; @@ -739,24 +757,10 @@ declare namespace dragController { * @throws { BusinessError } 100001 - Internal handling failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 - */ - /** - * Execute a drag event. - * @param { CustomBuilder | DragItemInfo } custom - Object used for prompts displayed when the object is dragged. - * @param { DragInfo } dragInfo - Information about the drag event. - * @returns { Promise } A Promise with the drag event information. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - Internal handling failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.DragController#executeDrag + * @arkts 1.1&1.2 */ function executeDrag(custom: CustomBuilder | DragItemInfo, dragInfo: DragInfo): Promise; @@ -789,26 +793,10 @@ declare namespace dragController { * @throws { BusinessError } 100001 - Internal handling failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 - */ - /** - * Create one drag action object, which can be used for starting drag later or monitoring - * the drag status after drag started. - * @param { Array } customArray - Objects used for prompts - * displayed when the objects are dragged. - * @param { DragInfo } dragInfo - Information about the drag event. - * @returns { DragAction } one drag action object - * @throws { BusinessError } 401 - Parameter error. Possible causes: - *
1. Mandatory parameters are left unspecified. - *
2. Incorrect parameters types. - *
3. Parameter verification failed. - * @throws { BusinessError } 100001 - Internal handling failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.DragController#createDragAction + * @arkts 1.1&1.2 */ function createDragAction(customArray: Array, dragInfo: DragInfo): DragAction; @@ -823,17 +811,10 @@ declare namespace dragController { * @returns { DragPreview } An drag preview object. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 - */ - /** - * Get drag preview object. - * @returns { DragPreview } An drag preview object. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 + * @since arkts {'1.1':'12','1.2':'20'} * @deprecated since 18 * @useinstead ohos.arkui.UIContext.DragController#getDragPreview + * @arkts 1.1&1.2 */ function getDragPreview(): DragPreview; @@ -843,7 +824,8 @@ declare namespace dragController { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ const enum DragStartRequestStatus { /** @@ -852,7 +834,8 @@ declare namespace dragController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ WAITING = 0, @@ -862,7 +845,8 @@ declare namespace dragController { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ READY = 1, } diff --git a/api/@ohos.arkui.drawableDescriptor.d.ts b/api/@ohos.arkui.drawableDescriptor.d.ts index 6c7ff4b6a3120ecd4095d063ccd187c9dcfe086a..9037ec994d42123108ee5421285f1cecda0f16f9 100644 --- a/api/@ohos.arkui.drawableDescriptor.d.ts +++ b/api/@ohos.arkui.drawableDescriptor.d.ts @@ -20,63 +20,6 @@ import image from './@ohos.multimedia.image'; -/** - * Indicates the return result of the data to be fetched. - * - * @typedef DrawableDescriptorResult - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface DrawableDescriptorResult { - /** - * DrawableDescriptor width.The default value is -1. - * - * @type { ?number } - * @readonly - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - readonly width?: number; - - /** - * DrawableDescriptor height.The default value is -1. - * - * @type { ?number } - * @readonly - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - readonly height?: number; -} - -/** - * DrawableDescriptor's option which is used in constructor. - * - * @typedef DrawableDescriptorOptions - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ -declare interface DrawableDescriptorOptions { - /** - * If true, it will fetch the data using the uri when object is constructing.The default value is false. - * - * @type { ?boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetchWhenConstructingWithUri?: boolean; -} - /** * Use the DrawableDescriptor class to get drawable image. * @@ -96,15 +39,17 @@ declare interface DrawableDescriptorOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -export class DrawableDescriptor { +export declare class DrawableDescriptor { /** * Creates a new DrawableDescriptor. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -130,57 +75,10 @@ export class DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getPixelMap(): image.PixelMap; - - /** - * Get original width of drawable object. - * - * @returns { number } Return the width of the DrawableDescriptor object. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - getOriginalWidth(): number; - - /** - * Get original height of drawable object. - * - * @returns { number } Return the height of the DrawableDescriptor object. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - getOriginalHeight(): number; - - /** - * Fetch the drawable's data whose corresponding uri is passed in constructor.This fetched data can be draw in Image view. - * - * @returns { Promise } Return the promise returned by the funciton. - * @throws { BusinessError } 100001 - Data loading failed. Maybe the uri is invalid. - * @throws { BusinessError } 100002 - Data decoding failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetch(): Promise; - - /** - * Fetch the drawable's data whose corresponding uri is passed in constructor.This fetched data can be draw in Image view. - * - * @returns { DrawableDescriptorResult } Return the result of the DrawableDescriptor object. - * @throws { BusinessError } 100001 - Data loading failed. Maybe the uri is invalid. - * @throws { BusinessError } 100002 - Data decoding failed. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetchSync(): DrawableDescriptorResult; } /** @@ -205,9 +103,10 @@ export class DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -export class LayeredDrawableDescriptor extends DrawableDescriptor { +export declare class LayeredDrawableDescriptor extends DrawableDescriptor { /** * Creates a new LayeredDrawableDescriptor. * @@ -216,7 +115,8 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor { * @param { DrawableDescriptor } [mask] - Indicates the mask option to create LayeredDrawableDescriptor. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor( foreground?: DrawableDescriptor, @@ -246,7 +146,8 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getForeground(): DrawableDescriptor; @@ -272,7 +173,8 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getBackground(): DrawableDescriptor; @@ -298,7 +200,8 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getMask(): DrawableDescriptor; @@ -325,7 +228,8 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static getMaskClipPath(): string; } @@ -336,28 +240,19 @@ export class LayeredDrawableDescriptor extends DrawableDescriptor { * @extends DrawableDescriptor * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -export class PixelMapDrawableDescriptor extends DrawableDescriptor { +export declare class PixelMapDrawableDescriptor extends DrawableDescriptor { /** * Creates a new PixelMapDrawableDescriptor. * @param { image.PixelMap } src - Indicates the resource to create PixelMapDrawableDescriptor. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(src?: image.PixelMap); - - /** - * Creates a new PixelMapDrawableDescriptor. - * @param { image.PixelMap | ResourceStr } src - Indicates the resource to create PixelMapDrawableDescriptor. - * @param { DrawableDescriptorOptions } options - Indicates the option to create PixelMapDrawableDescriptor. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - constructor(src?: image.PixelMap | ResourceStr, options?: DrawableDescriptorOptions); } /** @@ -367,7 +262,8 @@ export class PixelMapDrawableDescriptor extends DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare interface AnimationOptions { /** @@ -377,7 +273,8 @@ declare interface AnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; /** @@ -387,20 +284,10 @@ declare interface AnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iterations?: number; - - /** - * If true, it will fetch the data using the uri when object is constructing.The default value is false. - * - * @type { ?boolean } - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - fetchWhenConstructingWithUri?: boolean; } /** @@ -410,9 +297,10 @@ declare interface AnimationOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ -export class AnimatedDrawableDescriptor extends DrawableDescriptor { +export declare class AnimatedDrawableDescriptor extends DrawableDescriptor { /** * Creates a new AnimatedDrawableDescriptor. * @@ -421,52 +309,8 @@ export class AnimatedDrawableDescriptor extends DrawableDescriptor { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(pixelMaps: Array, options?: AnimationOptions); - - /** - * Creates a new AnimatedDrawableDescriptor. - * @param { Array | ResourceStr } pixelMaps - Indicates the resource to create AnimatedDrawableDescriptor. - * @param { ?AnimationOptions } [options] - Animation control options. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - constructor(pixelMaps: Array | ResourceStr, options?: AnimationOptions); - - /** - * Get the running status of animation. - * - * @returns { boolean } Return the running status of animation. - * @throws { BusinessError } 100001 - Image data is not ready.Maybe you should fetch the data first. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - isRunning(): boolean; - - /** - * Start the animation. - * - * @throws { BusinessError } 100001 - Image data is not ready.Maybe you should fetch the data first. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - start(): void; - - /** - * Stop the animation. - * - * @throws { BusinessError } 100001 - Image data is not ready.Maybe you should fetch the data first. - * @syscap SystemCapability.ArkUI.ArkUI.Full - * @crossplatform - * @atomicservice - * @since 18 - */ - stop(): void; } diff --git a/api/@ohos.arkui.inspector.d.ts b/api/@ohos.arkui.inspector.d.ts index e8c9892f5be456627ec11c277b16d84e1b025378..11f62dbe987ba22875609c784f56928cc7984176 100644 --- a/api/@ohos.arkui.inspector.d.ts +++ b/api/@ohos.arkui.inspector.d.ts @@ -31,7 +31,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace inspector { @@ -48,7 +49,8 @@ declare namespace inspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ComponentObserver { @@ -69,7 +71,8 @@ declare namespace inspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'layout', callback: () => void): void; @@ -90,7 +93,8 @@ declare namespace inspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'layout', callback?: () => void): void; @@ -111,7 +115,8 @@ declare namespace inspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'draw', callback: () => void): void; @@ -132,7 +137,8 @@ declare namespace inspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'draw', callback?: () => void): void; } @@ -152,11 +158,85 @@ declare namespace inspector { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 18 * @useinstead ohos.arkui.UIContext.UIInspector#createComponentObserver */ function createComponentObserver(id: string): ComponentObserver; + + /** + * Obtains all attributes of the component with the specified ID. + * + * @param { string } id - ID of the component whose attributes are to be obtained. + * @returns { string } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + function getInspectorByKey(id: string): string; + + /** + * Get components tree. + * + * @returns { Object } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + function getInspectorTree(): Object; + + /** + * Sends an event to the component with the specified ID. + * + * @param { string } id - ID of the component for which the event is to be sent. + * @param { number } action - Type of the event to be sent. The options are as follows: Click event: 10 LongClick: 11. + * @param { string } params - Event parameters. If there is no parameter, pass an empty string "". + * @returns { boolean } + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @test + * @arkts 1.2 + */ + function sendEventByKey(id: string, action: number, params: string): boolean; } export default inspector; +/** + * export function getInspectorByKey from inspector namespace and provide it for kit ArkUI. + * @constant + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export const GETINSPECTORBYKEY = inspector.getInspectorByKey; +/** + * export function getInspectorTree from inspector namespace and provide it for kit ArkUI. + * @constant + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export const GETINSPECTORTREE = inspector.getInspectorTree; +/** + * export function sendEventByKey from inspector namespace and provide it for kit ArkUI. + * @constant + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export const SENDEVENTBYKEY = inspector.sendEventByKey; \ No newline at end of file diff --git a/api/@ohos.arkui.node.d.ts b/api/@ohos.arkui.node.d.ts index 018747d717811a129a57671180669ff87fb1ab70..aa73335d6ecdc282541800c7e66409c98c887d46 100644 --- a/api/@ohos.arkui.node.d.ts +++ b/api/@ohos.arkui.node.d.ts @@ -29,7 +29,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { NodeRenderType, RenderOptions, BuilderNode } from './arkui/BuilderNode'; @@ -38,7 +39,8 @@ export { NodeRenderType, RenderOptions, BuilderNode } from './arkui/BuilderNode' * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { BuildOptions } from './arkui/BuilderNode'; @@ -57,7 +59,8 @@ export { BuildOptions } from './arkui/BuilderNode'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { NodeController } from './arkui/NodeController'; @@ -74,20 +77,20 @@ export { NodeController } from './arkui/NodeController'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { FrameNode, LayoutConstraint, ExpandMode } from './arkui/FrameNode'; - /** * Export FrameNode. FrameNode defines a basic type of node which contains a RenderNode. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { typeNode, NodeAdapter } from './arkui/FrameNode'; - /** * Export Graphics. Defines the basic types related to the Graphics. * @@ -101,17 +104,18 @@ export { typeNode, NodeAdapter } from './arkui/FrameNode'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { DrawContext, Size, Offset, Position, Pivot, Scale, Translation, Matrix4, Rotation, Frame, RoundRect, Circle, CommandPath, ShapeMask, ShapeClip, BorderRadiuses, CornerRadius, Rect, Edges, edgeColors, edgeWidths, borderStyles, borderRadiuses, LengthMetricsUnit } from './arkui/Graphics'; - /** * Export Graphics. Defines the basic types related to the Graphics. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { LengthUnit, SizeT, LengthMetrics, ColorMetrics } from './arkui/Graphics'; @@ -128,10 +132,11 @@ export { LengthUnit, SizeT, LengthMetrics, ColorMetrics } from './arkui/Graphics * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { RenderNode } from './arkui/RenderNode'; - +/*** if arkts 1.1 */ /** * Export XComponentNode, which extends FrameNode. * @@ -148,14 +153,15 @@ export { RenderNode } from './arkui/RenderNode'; * @since 12 */ export { XComponentNode } from './arkui/XComponentNode'; - +/*** endif */ /** * Export Content. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { Content } from './arkui/Content'; @@ -165,7 +171,8 @@ export { Content } from './arkui/Content'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { ComponentContent } from './arkui/ComponentContent'; @@ -175,6 +182,7 @@ export { ComponentContent } from './arkui/ComponentContent'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ export { NodeContent } from './arkui/NodeContent'; \ No newline at end of file diff --git a/api/@ohos.arkui.observer.d.ts b/api/@ohos.arkui.observer.d.ts index ea3a7070d3e855e1fd57d70bec5faae845c49396..5a56c4edfde2d39a92a101e3c7965455dc1dd50d 100644 --- a/api/@ohos.arkui.observer.d.ts +++ b/api/@ohos.arkui.observer.d.ts @@ -17,10 +17,19 @@ * @file * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { ResourceStr } from './arkui/component/units'; +import { NavPathStack, NavigationOperation, NavBar } from './arkui/component/navigation'; +import { UIContext } from '@ohos.arkui.UIContext'; +import UIAbilityContext from './application/UIAbilityContext'; +import { Callback } from './@ohos.base'; +/*** endif */ + +/*** if arkts 1.1 */ import type { Callback } from './@ohos.base'; import type UIAbilityContext from './application/UIAbilityContext'; import type { NavigationOperation, NavBar } from '../component/navigation'; +/*** endif */ /** * Register callbacks to observe ArkUI behavior. @@ -37,7 +46,8 @@ import type { NavigationOperation, NavBar } from '../component/navigation'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace uiObserver { /** @@ -55,7 +65,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum NavDestinationState { /** @@ -71,7 +82,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_SHOWN = 0, @@ -88,7 +100,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_HIDDEN = 1, @@ -98,7 +111,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_APPEAR = 2, @@ -108,7 +122,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_DISAPPEAR = 3, @@ -118,7 +133,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_WILL_SHOW = 4, @@ -128,7 +144,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_WILL_HIDE = 5, @@ -138,7 +155,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_WILL_APPEAR = 6, @@ -148,7 +166,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_WILL_DISAPPEAR = 7, @@ -178,7 +197,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_BACKPRESS = 100 } @@ -198,7 +218,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum RouterPageState { /** @@ -214,7 +235,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ABOUT_TO_APPEAR = 0, @@ -231,7 +253,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ABOUT_TO_DISAPPEAR = 1, @@ -248,7 +271,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_PAGE_SHOW = 2, @@ -265,7 +289,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_PAGE_HIDE = 3, @@ -282,7 +307,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_BACK_PRESS = 4 } @@ -294,7 +320,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum ScrollEventType { /** @@ -303,7 +330,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_START = 0, @@ -313,7 +341,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_STOP = 1 } @@ -325,7 +354,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum TabContentState { /** @@ -334,7 +364,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_SHOW = 0, @@ -344,7 +375,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ON_HIDE = 1 } @@ -364,7 +396,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NavDestinationInfo { /** @@ -382,7 +415,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ navigationId: ResourceStr, @@ -401,7 +435,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: ResourceStr, @@ -420,7 +455,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ state: NavDestinationState, @@ -431,7 +467,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -442,7 +479,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ param?: Object; @@ -453,7 +491,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ navDestinationId: string; @@ -487,7 +526,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NavigationInfo { /** @@ -497,7 +537,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ navigationId: string; @@ -508,7 +549,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pathStack: NavPathStack; } @@ -520,7 +562,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ScrollEventInfo { /** @@ -530,7 +573,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: string, @@ -541,7 +585,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ uniqueId: number, @@ -552,7 +597,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scrollEvent: ScrollEventType, @@ -563,7 +609,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number } @@ -575,7 +622,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface TabContentInfo { /** @@ -585,7 +633,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ tabContentId: string, @@ -596,7 +645,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ tabContentUniqueId: number, @@ -607,7 +657,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ state: TabContentState, @@ -618,7 +669,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number, @@ -629,7 +681,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: string, @@ -640,7 +693,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ uniqueId: number } @@ -652,7 +706,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ObserverOptions { /** @@ -662,7 +717,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: string } @@ -680,7 +736,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export class RouterPageInfo { /** @@ -698,7 +755,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ context: UIAbilityContext | UIContext; @@ -717,7 +775,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; @@ -736,7 +795,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -755,7 +815,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ path: string; @@ -774,7 +835,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ state: RouterPageState; @@ -785,7 +847,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pageId: string; } @@ -796,7 +859,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export class DensityInfo { /** @@ -806,7 +870,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ context: UIContext; @@ -817,7 +882,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ density: number; } @@ -829,7 +895,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NavDestinationSwitchInfo { /** @@ -839,7 +906,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ context: UIAbilityContext | UIContext; @@ -850,7 +918,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ from: NavDestinationInfo | NavBar; @@ -861,7 +930,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ to: NavDestinationInfo | NavBar; @@ -872,7 +942,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ operation: NavigationOperation; } @@ -884,7 +955,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NavDestinationSwitchObserverOptions { /** @@ -894,7 +966,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ navigationId: ResourceStr; } @@ -921,6 +994,20 @@ declare namespace uiObserver { * @since 12 */ export function on(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback: Callback): void; + + /** + * Registers a callback function to be called when the navigation destination is updated. + * + * @param { 'navDestinationUpdate' } type - The type of event to listen for. Must be 'navDestinationUpdate'. + * @param { NavDestinationSwitchObserverOptions } options - The options object. + * @param { Callback } callback - The callback function to be called when the navigation destination is updated. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function on(type: 'navDestinationUpdate', options: NavDestinationSwitchObserverOptions, callback: Callback): void; /** * Removes a callback function that was previously registered with `on()`. @@ -946,6 +1033,21 @@ declare namespace uiObserver { * @since 12 */ export function off(type: 'navDestinationUpdate', options: { navigationId: ResourceStr }, callback?: Callback): void; + + /** + * Removes a callback function that was previously registered with `on()`. + * + * @param { 'navDestinationUpdate' } type - The type of event to remove the listener for. Must be 'navDestinationUpdate'. + * @param { NavDestinationSwitchObserverOptions } options - The options object. + * @param { Callback } callback - The callback function to remove. If not provided, all callbacks for the given event type and + * navigation ID will be removed. + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function off(type: 'navDestinationUpdate', options: NavDestinationSwitchObserverOptions, callback?: Callback): void; /** * Registers a callback function to be called when the navigation destination is updated. @@ -964,7 +1066,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'navDestinationUpdate', callback: Callback): void; @@ -987,7 +1090,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'navDestinationUpdate', callback?: Callback): void; @@ -1000,7 +1104,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'scrollEvent', options: ObserverOptions, callback: Callback): void; @@ -1014,7 +1119,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'scrollEvent', options: ObserverOptions, callback?: Callback): void; @@ -1026,7 +1132,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'scrollEvent', callback: Callback): void; @@ -1039,7 +1146,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'scrollEvent', callback?: Callback): void; @@ -1062,7 +1170,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'routerPageUpdate', context: UIAbilityContext | UIContext, callback: Callback): void; @@ -1087,7 +1196,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'routerPageUpdate', context: UIAbilityContext | UIContext, callback?: Callback): void; @@ -1100,7 +1210,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'densityUpdate', context: UIContext, callback: Callback): void; @@ -1114,7 +1225,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'densityUpdate', context: UIContext, callback?: Callback): void; @@ -1127,7 +1239,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'willDraw', context: UIContext, callback: Callback): void; @@ -1141,7 +1254,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'willDraw', context: UIContext, callback?: Callback): void; @@ -1154,7 +1268,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'didLayout', context: UIContext, callback: Callback): void; @@ -1168,7 +1283,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'didLayout', context: UIContext, callback?: Callback): void; @@ -1181,7 +1297,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'tabContentUpdate', options: ObserverOptions, callback: Callback): void; @@ -1195,7 +1312,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'tabContentUpdate', options: ObserverOptions, callback?: Callback): void; @@ -1207,7 +1325,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on(type: 'tabContentUpdate', callback: Callback): void; @@ -1220,7 +1339,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off(type: 'tabContentUpdate', callback?: Callback): void; @@ -1233,7 +1353,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on( type: 'navDestinationSwitch', @@ -1251,7 +1372,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off( type: 'navDestinationSwitch', @@ -1269,7 +1391,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function on( type: 'navDestinationSwitch', @@ -1289,7 +1412,8 @@ declare namespace uiObserver { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export function off( type: 'navDestinationSwitch', diff --git a/api/@ohos.arkui.performanceMonitor.d.ts b/api/@ohos.arkui.performanceMonitor.d.ts index bb553c4286dfb4e3c3d86e0d8abb154caeedddf9..5f64735337d276e29544a4254f87cb593e156ce7 100644 --- a/api/@ohos.arkui.performanceMonitor.d.ts +++ b/api/@ohos.arkui.performanceMonitor.d.ts @@ -37,7 +37,8 @@ * @namespace performanceMonitor * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace performanceMonitor { /** @@ -46,14 +47,16 @@ declare namespace performanceMonitor { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export enum ActionType { /** * The user presses the finger on the screen. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ LAST_DOWN = 0, @@ -61,7 +64,8 @@ declare namespace performanceMonitor { * The user lifts up the finger from the screen. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ LAST_UP = 1, @@ -69,7 +73,8 @@ declare namespace performanceMonitor { * The user first moves the finger after pressing down the screen. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FIRST_MOVE = 2 } @@ -80,14 +85,16 @@ declare namespace performanceMonitor { * @enum { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum SourceType { /** * The user touches the screen to trigger the scene. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERF_TOUCH_EVENT = 0, @@ -95,7 +102,8 @@ declare namespace performanceMonitor { * TThe user uses the mouse to trigger the scene. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERF_MOUSE_EVENT = 1, @@ -103,7 +111,8 @@ declare namespace performanceMonitor { * The user uses the touchpad to trigger the scene. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERF_TOUCHPAD_EVENT = 2, @@ -111,7 +120,8 @@ declare namespace performanceMonitor { * The user uses the joystick to trigger the scene. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERF_JOYSTICK_EVENT = 3, @@ -119,7 +129,8 @@ declare namespace performanceMonitor { * The user uses the keyboard to trigger the scene. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERF_KEY_EVENT = 4 } @@ -132,7 +143,8 @@ declare namespace performanceMonitor { * @param { string } note Indicates the app expected info delivered. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function begin(scene: string, startInputType: ActionType, note?: string): void; @@ -142,7 +154,8 @@ declare namespace performanceMonitor { * @param { string } scene Indicates the scene name. It must be the same with the {@code scene} of start. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function end(scene: string): void; @@ -155,7 +168,8 @@ declare namespace performanceMonitor { * @throws { BusinessError } 202 - not system application. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function recordInputEventTime(type: ActionType, sourceType: SourceType, time: number): void; } diff --git a/api/@ohos.arkui.shape.d.ts b/api/@ohos.arkui.shape.d.ts index f4688f6e5c8e55933a4ed6dce5fd5772008173d0..ebcc33c6649e75a4e75b1b9712da344d02f3a607 100644 --- a/api/@ohos.arkui.shape.d.ts +++ b/api/@ohos.arkui.shape.d.ts @@ -18,7 +18,9 @@ * @kit ArkUI */ - +/*** if arkts 1.2 */ +import { Position, ResourceColor, Length, SizeOptions } from './arkui/component/units' +/*** endif */ /** * Interface for shape size properties. @@ -28,7 +30,8 @@ * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ShapeSize { /** @@ -37,7 +40,8 @@ interface ShapeSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width?: number | string; @@ -47,7 +51,8 @@ interface ShapeSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number | string; } @@ -61,7 +66,8 @@ interface ShapeSize { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RectShapeOptions extends ShapeSize { /** @@ -70,7 +76,8 @@ interface RectShapeOptions extends ShapeSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius?: number | string | Array; } @@ -84,7 +91,8 @@ interface RectShapeOptions extends ShapeSize { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RoundRectShapeOptions extends ShapeSize { /** @@ -93,7 +101,8 @@ interface RoundRectShapeOptions extends ShapeSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radiusWidth?: number | string; @@ -103,7 +112,8 @@ interface RoundRectShapeOptions extends ShapeSize { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radiusHeight?: number | string; } @@ -116,7 +126,8 @@ interface RoundRectShapeOptions extends ShapeSize { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PathShapeOptions { /** @@ -125,7 +136,8 @@ interface PathShapeOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ commands?: string; } @@ -137,7 +149,8 @@ interface PathShapeOptions { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class CommonShapeMethod { /** @@ -149,7 +162,8 @@ declare class CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset(offset: Position): T; @@ -162,7 +176,8 @@ declare class CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fill(color: ResourceColor): T; @@ -175,7 +190,8 @@ declare class CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ position(position: Position): T; } @@ -188,7 +204,8 @@ declare class CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare class BaseShape extends CommonShapeMethod { /** @@ -200,7 +217,8 @@ declare class BaseShape extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width(width: Length): T; @@ -213,7 +231,8 @@ declare class BaseShape extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height(height: Length): T; @@ -226,7 +245,8 @@ declare class BaseShape extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size(size: SizeOptions): T; } @@ -239,7 +259,8 @@ declare class BaseShape extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare class RectShape extends BaseShape { /** @@ -250,7 +271,8 @@ export declare class RectShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(options?: RectShapeOptions | RoundRectShapeOptions); @@ -263,7 +285,8 @@ export declare class RectShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radiusWidth(rWidth: number | string): RectShape; @@ -276,7 +299,8 @@ export declare class RectShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radiusHeight(rHeight: number | string): RectShape; @@ -289,7 +313,8 @@ export declare class RectShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ radius(radius: number | string | Array): RectShape; } @@ -302,7 +327,8 @@ export declare class RectShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare class CircleShape extends BaseShape { /** @@ -313,7 +339,8 @@ export declare class CircleShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(options?: ShapeSize); } @@ -326,7 +353,8 @@ export declare class CircleShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare class EllipseShape extends BaseShape { /** @@ -337,7 +365,8 @@ export declare class EllipseShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(options?: ShapeSize); } @@ -350,7 +379,8 @@ export declare class EllipseShape extends BaseShape { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare class PathShape extends CommonShapeMethod { /** @@ -361,7 +391,8 @@ export declare class PathShape extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(options?: PathShapeOptions); @@ -374,7 +405,8 @@ export declare class PathShape extends CommonShapeMethod { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ commands(commands: string): PathShape; } \ No newline at end of file diff --git a/api/@ohos.arkui.stateManagement.d.ets b/api/@ohos.arkui.stateManagement.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..02653fb237eac2ec0b7b444a13795102d808e61d --- /dev/null +++ b/api/@ohos.arkui.stateManagement.d.ets @@ -0,0 +1,25 @@ +/* + * Copyright (C) 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 State management API file + * @kit ArkUI + * @arkts 1.2 + */ + +export * from './arkui/stateManagement/decorator'; +export * from './arkui/stateManagement/runtime'; +export * from './arkui/stateManagement/storage/appStorage'; +export * from './arkui/stateManagement/storage/localStorage'; \ No newline at end of file diff --git a/api/@ohos.arkui.theme.d.ts b/api/@ohos.arkui.theme.d.ts index bec047f52697f106ecc076ddb9293cfb431d6a38..50f2062772205f75c8b4595c24474139a5a9aeee 100644 --- a/api/@ohos.arkui.theme.d.ts +++ b/api/@ohos.arkui.theme.d.ts @@ -18,6 +18,11 @@ * @file * @kit ArkUI */ + +/*** if arkts 1.2 */ +import { ResourceColor } from './arkui/component/units'; +/*** endif */ + /** * Defines the struct of Theme. * @@ -25,7 +30,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface Theme { /** @@ -35,7 +41,8 @@ export declare interface Theme { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ colors: Colors; } @@ -47,7 +54,8 @@ export declare interface Theme { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface Colors { @@ -58,7 +66,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ brand: ResourceColor; @@ -69,7 +78,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ warning: ResourceColor; @@ -80,7 +90,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alert: ResourceColor; @@ -91,7 +102,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ confirm: ResourceColor; @@ -102,7 +114,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontPrimary: ResourceColor; @@ -113,7 +126,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSecondary: ResourceColor; @@ -124,7 +138,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontTertiary: ResourceColor; @@ -135,7 +150,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFourth: ResourceColor; @@ -146,7 +162,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontEmphasize: ResourceColor; @@ -157,7 +174,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontOnPrimary: ResourceColor; @@ -168,7 +186,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontOnSecondary: ResourceColor; @@ -179,7 +198,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontOnTertiary: ResourceColor; @@ -190,7 +210,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontOnFourth: ResourceColor; @@ -201,7 +222,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconPrimary: ResourceColor; @@ -212,7 +234,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconSecondary: ResourceColor; @@ -223,7 +246,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconTertiary: ResourceColor; @@ -234,7 +258,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconFourth: ResourceColor; @@ -245,7 +270,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconEmphasize: ResourceColor; @@ -256,7 +282,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconSubEmphasize: ResourceColor; @@ -267,7 +294,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconOnPrimary: ResourceColor; @@ -278,7 +306,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconOnSecondary: ResourceColor; @@ -289,7 +318,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconOnTertiary: ResourceColor; @@ -300,7 +330,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ iconOnFourth: ResourceColor; @@ -311,7 +342,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundPrimary: ResourceColor; @@ -322,7 +354,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundSecondary: ResourceColor; @@ -333,7 +366,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundTertiary: ResourceColor; @@ -344,7 +378,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundFourth: ResourceColor; @@ -355,7 +390,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundEmphasize: ResourceColor; @@ -366,7 +402,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compForegroundPrimary: ResourceColor; @@ -377,7 +414,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundPrimary: ResourceColor; @@ -388,7 +426,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundPrimaryTran: ResourceColor; @@ -399,7 +438,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundPrimaryContrary: ResourceColor; @@ -410,7 +450,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundGray: ResourceColor; @@ -421,7 +462,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundSecondary: ResourceColor; @@ -432,7 +474,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundTertiary: ResourceColor; @@ -443,7 +486,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundEmphasize: ResourceColor; @@ -454,7 +498,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundNeutral: ResourceColor; @@ -465,7 +510,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compEmphasizeSecondary: ResourceColor; @@ -476,7 +522,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compEmphasizeTertiary: ResourceColor; @@ -487,7 +534,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compDivider: ResourceColor; @@ -498,7 +546,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compCommonContrary: ResourceColor; @@ -509,7 +558,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compBackgroundFocus: ResourceColor; @@ -520,7 +570,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compFocusedPrimary: ResourceColor; @@ -531,7 +582,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compFocusedSecondary: ResourceColor; @@ -542,7 +594,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ compFocusedTertiary: ResourceColor; @@ -553,7 +606,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interactiveHover: ResourceColor; @@ -564,7 +618,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interactivePressed: ResourceColor; @@ -575,7 +630,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interactiveFocus: ResourceColor; @@ -586,7 +642,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interactiveActive: ResourceColor; @@ -597,7 +654,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interactiveSelect: ResourceColor; @@ -608,7 +666,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interactiveClick: ResourceColor; } @@ -620,7 +679,8 @@ export declare interface Colors { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface CustomTheme { /** @@ -630,7 +690,8 @@ export declare interface CustomTheme { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ colors?: CustomColors; } @@ -646,13 +707,26 @@ export declare interface CustomTheme { */ export declare type CustomColors = Partial; +/** + * Defines the struct of CustomColors. + * + * @typedef { Partial } CustomColors + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ +export type CustomColors = Partial; + /** * Class ThemeControl provides the Theme management for whole Ability and pages. * * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare class ThemeControl { /** @@ -664,7 +738,8 @@ export declare class ThemeControl { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static setDefaultTheme(theme: CustomTheme): void; } diff --git a/api/@ohos.arkui.uiExtension.d.ts b/api/@ohos.arkui.uiExtension.d.ts index 8f34c776a39d33c4c672a59514510d48d6ca3847..44cd4566b3e8f1a3fe59bed94997f36921f4545c 100644 --- a/api/@ohos.arkui.uiExtension.d.ts +++ b/api/@ohos.arkui.uiExtension.d.ts @@ -28,7 +28,8 @@ import window from './@ohos.window'; * @namespace uiExtension * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace uiExtension { /** @@ -37,9 +38,10 @@ declare namespace uiExtension { * @interface WindowProxy * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface WindowProxy { + export interface WindowProxy { /** * Get the avoid area. * @@ -51,7 +53,8 @@ declare namespace uiExtension { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getWindowAvoidArea(type: window.AvoidAreaType): window.AvoidArea; @@ -66,7 +69,8 @@ declare namespace uiExtension { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'avoidAreaChange', callback: Callback): void; @@ -81,7 +85,8 @@ declare namespace uiExtension { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'avoidAreaChange', callback?: Callback): void; @@ -96,7 +101,8 @@ declare namespace uiExtension { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'windowSizeChange', callback: Callback): void; @@ -111,7 +117,8 @@ declare namespace uiExtension { *
3. Parameter verification failed. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'windowSizeChange', callback?: Callback): void; @@ -166,7 +173,8 @@ declare namespace uiExtension { * @throws { BusinessError } 1300003 - This window manager service works abnormally. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ hideNonSecureWindows(shouldHide: boolean): Promise; @@ -186,7 +194,8 @@ declare namespace uiExtension { * @syscap SystemCapability.ArkUI.ArkUI.Full * @StageModelOnly * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ createSubWindowWithOptions(name: string, subWindowOptions: window.SubWindowOptions): Promise; @@ -200,7 +209,8 @@ declare namespace uiExtension { * @throws { BusinessError } 1300008 - The display device is abnormal. * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setWaterMarkFlag(enable: boolean): Promise; @@ -305,16 +315,18 @@ declare namespace uiExtension { * @interface AvoidAreaInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface AvoidAreaInfo { + export interface AvoidAreaInfo { /** * Describes the type of avoid area. * * @type { window.AvoidAreaType } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type: window.AvoidAreaType; @@ -324,7 +336,8 @@ declare namespace uiExtension { * @type { window.AvoidArea } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ area: window.AvoidArea; } @@ -335,17 +348,19 @@ declare namespace uiExtension { * @interface WindowProxyProperties * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 * */ - interface WindowProxyProperties { + export interface WindowProxyProperties { /** * The position and size of the UIExtension window * * @type { window.Rect } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ uiExtensionHostWindowProxyRect: window.Rect; } diff --git a/api/@ohos.base.d.ets b/api/@ohos.base.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..39f9d3995fd8fcee34650181e05a732a7468c206 --- /dev/null +++ b/api/@ohos.base.d.ets @@ -0,0 +1,177 @@ +/* + * Copyright (c) 2021-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. + */ + +/** + * @file + * @kit BasicServicesKit + */ + +/** + * Defines the basic callback. + * + * @typedef { Callback } + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type Callback = (data: T) => void; + +/** + * Defines the basic error callback. + * + * @typedef { ErrorCallback } + * @syscap SystemCapability.Base + * @crossplatform + * @atomicservice + * @since 20 + */ +export type ErrorCallback = (err: T)=> void; + +/** + * Defines the basic async callback. + * + * @typedef { AsyncCallback } + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type AsyncCallback = (err: BusinessError, data: T)=> void; + +/** + * Defines the error interface. + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export declare class BusinessError extends Error { + /** + * A constructor used to create a BusinessError object + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + constructor(); + /** + * A constructor used to create a BusinessError object + * @params { number } code + * @params { Error } error + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + constructor(code: number, error: Error); + /** + * A constructor used to create a BusinessError object + * @params { number } code + * @params { T } data + * @params { Error } error + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + constructor(code: number, data: T, error: Error); + /** + * Defines the basic error code. + * @type { number } code + * @syscap SystemCapability.Base + * @since 6 + */ + /** + * Defines the basic error code. + * @type { number } code + * @syscap SystemCapability.Base + * @crossplatform + * @since 10 + */ + /** + * Defines the basic error code. + * @type { number } code + * @syscap SystemCapability.Base + * @crossplatform + * @atomicservice + * @since 11 + */ + /** + * Defines the basic error code. + * @type { number } code + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + /** + * Defines the basic error code. + * @type { number } code + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + code: number; + /** + * Defines the additional information for business + * @type { ?T } data + * @syscap SystemCapability.Base + * @since 9 + */ + /** + * Defines the additional information for business + * @type { ?T } data + * @syscap SystemCapability.Base + * @crossplatform + * @since 10 + */ + /** + * Defines the additional information for business + * @type { ?T } data + * @syscap SystemCapability.Base + * @crossplatform + * @atomicservice + * @since 11 + */ + /** + * Defines the additional information for business + * @type { ?T } data + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 12 + */ + /** + * Defines the additional information for business + * @type { ?T } data + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ + data?: T; +} diff --git a/api/@ohos.base.d.ts b/api/@ohos.base.d.ts index b9930a4b6fd6d393f4a13ed87f19241bed4f52da..d56214a167db0a9e9832b97e3181b24a5b2900a9 100644 --- a/api/@ohos.base.d.ts +++ b/api/@ohos.base.d.ts @@ -84,7 +84,7 @@ export interface Callback { /** * Defines the basic error callback. - * @typedef ErrorCallback + * @typedef ErrorCallback * @syscap SystemCapability.Base * @since 6 */ @@ -291,3 +291,50 @@ export interface BusinessError extends Error { */ data?: T; } + +/** + * In ArkTS 1.1, using int is equivalent to using number + * + * @typedef { number } + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type int = number; + +/** + * In ArkTS 1.1, using double is equivalent to using number + * + * @typedef { number } + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type double = number; +/** + * In ArkTS 1.1, using float is equivalent to using number + * + * @typedef { number } + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type float = number; + +/** + * In ArkTS 1.1, using long is equivalent to using number + * + * @typedef { number } + * @syscap SystemCapability.Base + * @crossplatform + * @form + * @atomicservice + * @since 20 + */ +export type long = number; diff --git a/api/@ohos.batteryInfo.d.ets b/api/@ohos.batteryInfo.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..a5585c54f63074c3e844f1c3d89fe8a665c0eb6b --- /dev/null +++ b/api/@ohos.batteryInfo.d.ets @@ -0,0 +1,453 @@ +/* + * Copyright (c) 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 BasicServicesKit + */ + +/** + * Obtains battery information of a device. + *

Battery information includes the remaining battery power, + * voltage, temperature, model, and charger type. + * + * @namespace batteryInfo + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ +declare namespace batteryInfo { + /** + * Sets the battery config by scene name. + * + * @param { string } sceneName - Indicates the battery charging scene name. + * sceneName parameter must be of type string. + * @param { string } sceneValue - Indicates the battery charging scene value. + * sceneValue parameter must be of type string. + * @returns { int } Return to set the charging configuration result. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; + * @throws { BusinessError } 5100101 - Failed to connect to the service. + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @systemapi + * @since 20 + */ + function setBatteryConfig(sceneName: string, sceneValue: string): int; + + /** + * Queries the battery config by scene name. + * + * @param { string } sceneName - Indicates the battery charging scene name. + * sceneName parameter must be of type string. + * @returns { string } Returns the battery charging configuration, returns "" otherwise. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; + * @throws { BusinessError } 5100101 - Failed to connect to the service. + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @systemapi + * @since 20 + */ + function getBatteryConfig(sceneName: string): string; + + /** + * Checks the battery config is enable by scene name. + * + * @param { string } sceneName - Indicates the battery charging scene name. + * sceneName parameter must be of type string. + * @returns { boolean } Returns true if the device supports the charging scene, returns false otherwise. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types; + * @throws { BusinessError } 5100101 - Failed to connect to the service. + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @systemapi + * @since 20 + */ + function isBatteryConfigSupported(sceneName: string): boolean; + + /** + * Battery state of charge (SoC) of the current device, in percent. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + function batterySOC(): int; + + /** + * Battery charging status of the current device. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + function chargingStatus(): BatteryChargeState; + + /** + * Battery health state of the current device. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function healthStatus(): BatteryHealthState; + + /** + * Charger type of the current device. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function pluggedType(): BatteryPluggedType; + + /** + * Battery voltage of the current device, in µV. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function voltage(): int; + + /** + * Battery technology of the current device. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function technology(): string; + + /** + * Battery temperature of the current device, in 0.1℃. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function batteryTemperature(): int; + + /** + * Battery present state of the current device. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function isBatteryPresent(): boolean; + + /** + * Battery capacity level of the current device. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function batteryCapacityLevel(): BatteryCapacityLevel; + + /** + * Estimated remaining time for the current device to be fully charged, in ms. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @systemapi + * @since 20 + */ + function estimatedRemainingChargeTime(): long; + + /** + * Battery total energy of the current device, in mAh. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @systemapi + * @since 20 + */ + function totalEnergy(): int; + + /** + * Battery immediate current of the current device, in mA. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + function nowCurrent(): int; + + /** + * Battery remaining energy of the current device, in mAh. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @systemapi + * @since 20 + */ + function remainingEnergy(): int; + + /** + * Charger type of a device. + * + * @enum { int } + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + export enum BatteryPluggedType { + /** + * Unknown type + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + NONE, + /** + * AC charger + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + AC, + /** + * USB charger + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + USB, + /** + * Wireless charger + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + WIRELESS + } + + /** + * Battery charging status of a device. + * + * @enum { int } + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + export enum BatteryChargeState { + /** + * Unknown state. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + NONE, + /** + * The battery is being charged. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + ENABLE, + /** + * The battery is not being charged. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + DISABLE, + /** + * The battery is fully charged. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @atomicservice + * @since 20 + */ + FULL + } + + /** + * Battery health status of a device. + * + * @enum { int } + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + export enum BatteryHealthState { + /** + * Unknown state. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + UNKNOWN, + /** + * The battery is in healthy state. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + GOOD, + /** + * The battery is overheated. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + OVERHEAT, + /** + * The battery voltage is over high. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + OVERVOLTAGE, + /** + * The battery temperature is low. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + COLD, + /** + * The battery is dead. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + DEAD + } + + /** + * Battery capacity level of a device. + * + * @enum { int } + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + export enum BatteryCapacityLevel { + /** + * The battery is in full capacity level. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_FULL, + /** + * The battery is in high capacity level. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_HIGH, + /** + * The battery is in normal capacity level. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_NORMAL, + /** + * The battery is in low capacity level. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_LOW, + /** + * The battery is in warning low capacity level. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_WARNING, + /** + * The battery is in critical low capacity level. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_CRITICAL, + /** + * The battery is in the lowest capacity level, system will shut down automatically in a few seconds. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + LEVEL_SHUTDOWN + } + + /** + * Extra key of common event COMMON_EVENT_BATTERY_CHANGED. + * + * @enum { string } + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + export enum CommonEventBatteryChangedKey { + /** + * Extra code of batterySOC. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_SOC = 'soc', + /** + * Extra code of chargingStatus. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_CHARGE_STATE = 'chargeState', + /** + * Extra code of healthStatus. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_HEALTH_STATE = 'healthState', + /** + * Extra code of pluggedType. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_PLUGGED_TYPE = 'pluggedType', + /** + * Extra code of voltage. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_VOLTAGE = 'voltage', + /** + * Extra code of technology. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_TECHNOLOGY = 'technology', + /** + * Extra code of batteryTemperature. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_TEMPERATURE = 'temperature', + /** + * Extra code of isBatteryPresent. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_PRESENT = 'present', + /** + * Extra code of batteryCapacityLevel. + * + * @syscap SystemCapability.PowerManager.BatteryManager.Core + * @since 20 + */ + EXTRA_CAPACITY_LEVEL = 'capacityLevel' + } +} +export default batteryInfo; diff --git a/api/@ohos.bluetooth.a2dp.d.ts b/api/@ohos.bluetooth.a2dp.d.ts index 1dfc2f3d3c931a90804dc13de61abc15798e5598..6e2402d568c3f25efef79bed90460c5003850167 100644 --- a/api/@ohos.bluetooth.a2dp.d.ts +++ b/api/@ohos.bluetooth.a2dp.d.ts @@ -34,7 +34,8 @@ import type baseProfile from './@ohos.bluetooth.baseProfile'; * @namespace a2dp * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace a2dp { /** @@ -42,7 +43,8 @@ declare namespace a2dp { * * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type BaseProfile = baseProfile.BaseProfile; @@ -65,7 +67,8 @@ declare namespace a2dp { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function createA2dpSrcProfile(): A2dpSourceProfile; @@ -83,7 +86,8 @@ declare namespace a2dp { * @typedef A2dpSourceProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface A2dpSourceProfile extends BaseProfile { /** diff --git a/api/@ohos.bluetooth.access.d.ts b/api/@ohos.bluetooth.access.d.ts index 0ce9d06f189e612b002af91b3597f82af28bd067..e04cf930b17c5c48f9964bca2114fa1d6d405a36 100644 --- a/api/@ohos.bluetooth.access.d.ts +++ b/api/@ohos.bluetooth.access.d.ts @@ -42,7 +42,8 @@ import type { AsyncCallback, Callback } from './@ohos.base'; * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace access { /** @@ -79,7 +80,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function enableBluetooth(): void; @@ -117,7 +119,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function disableBluetooth(): void; @@ -133,7 +136,8 @@ declare namespace access { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function restrictBluetooth(): Promise; @@ -172,7 +176,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function getState(): BluetoothState; @@ -283,7 +288,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'stateChange', callback: Callback): void; @@ -330,7 +336,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'stateChange', callback?: Callback): void; @@ -424,7 +431,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ export enum BluetoothState { /** @@ -446,7 +454,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_OFF = 0, /** @@ -468,7 +477,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_TURNING_ON = 1, /** @@ -490,7 +500,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_ON = 2, /** @@ -512,7 +523,8 @@ declare namespace access { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_TURNING_OFF = 3, /** @@ -526,7 +538,8 @@ declare namespace access { * * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_BLE_TURNING_ON = 4, /** @@ -540,7 +553,8 @@ declare namespace access { * * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_BLE_ON = 5, /** @@ -554,7 +568,8 @@ declare namespace access { * * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_BLE_TURNING_OFF = 6 } diff --git a/api/@ohos.bluetooth.baseProfile.d.ts b/api/@ohos.bluetooth.baseProfile.d.ts index 5034765d55393669c5358900e8ba9a7fb31a1d0f..ad71f84813066552bef34c9d1c90e519cef9048f 100644 --- a/api/@ohos.bluetooth.baseProfile.d.ts +++ b/api/@ohos.bluetooth.baseProfile.d.ts @@ -34,7 +34,8 @@ import type constant from './@ohos.bluetooth.constant'; * @namespace baseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace baseProfile { /** @@ -50,7 +51,8 @@ declare namespace baseProfile { * @typedef { constant.ProfileConnectionState } ProfileConnectionState * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ type ProfileConnectionState = constant.ProfileConnectionState; @@ -169,7 +171,8 @@ declare namespace baseProfile { * @typedef StateChangeParam * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ export interface StateChangeParam { /** @@ -185,7 +188,8 @@ declare namespace baseProfile { * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; @@ -202,7 +206,8 @@ declare namespace baseProfile { * @type { ProfileConnectionState } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ state: ProfileConnectionState; @@ -237,7 +242,8 @@ declare namespace baseProfile { * @typedef BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ export interface BaseProfile { /** @@ -419,7 +425,8 @@ declare namespace baseProfile { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'connectionStateChange', callback: Callback): void; diff --git a/api/@ohos.bluetooth.ble.d.ts b/api/@ohos.bluetooth.ble.d.ts index 4b13084e3a443716b10b55a4cf9a4e8c893d423f..0a0853d7e7ec369fb44bc2c2a005ba5ee0e48c36 100644 --- a/api/@ohos.bluetooth.ble.d.ts +++ b/api/@ohos.bluetooth.ble.d.ts @@ -43,7 +43,8 @@ import type constant from './@ohos.bluetooth.constant'; * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace ble { /** @@ -67,7 +68,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ type ProfileConnectionState = constant.ProfileConnectionState; @@ -93,7 +95,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function createGattServer(): GattServer; @@ -131,7 +134,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function createGattClientDevice(deviceId: string): GattClientDevice; @@ -276,7 +280,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function stopBLEScan(): void; @@ -373,7 +378,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function stopAdvertising(): void; @@ -564,7 +570,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function stopAdvertising(advertisingId: number, callback: AsyncCallback): void; @@ -601,7 +608,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function stopAdvertising(advertisingId: number): Promise; @@ -632,7 +640,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'advertisingStateChange', callback: Callback): void; @@ -663,7 +672,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'advertisingStateChange', callback?: Callback): void; @@ -710,7 +720,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'BLEDeviceFind', callback: Callback>): void; @@ -757,7 +768,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'BLEDeviceFind', callback?: Callback>): void; @@ -783,7 +795,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface GattServer { /** @@ -929,7 +942,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; @@ -1145,7 +1159,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'characteristicRead', callback: Callback): void; @@ -1189,7 +1204,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'characteristicRead', callback?: Callback): void; @@ -1233,7 +1249,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'characteristicWrite', callback: Callback): void; @@ -1277,7 +1294,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'characteristicWrite', callback?: Callback): void; @@ -1321,7 +1339,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'descriptorRead', callback: Callback): void; @@ -1365,7 +1384,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'descriptorRead', callback?: Callback): void; @@ -1409,7 +1429,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'descriptorWrite', callback: Callback): void; @@ -1453,7 +1474,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'descriptorWrite', callback?: Callback): void; @@ -1497,7 +1519,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'connectionStateChange', callback: Callback): void; @@ -1541,7 +1564,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'connectionStateChange', callback?: Callback): void; @@ -1570,7 +1594,8 @@ declare namespace ble { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'BLEMtuChange', callback: Callback): void; @@ -1599,7 +1624,8 @@ declare namespace ble { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'BLEMtuChange', callback?: Callback): void; } @@ -1626,7 +1652,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface GattClientDevice { /** @@ -1669,7 +1696,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ connect(): void; @@ -1710,7 +1738,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ disconnect(): void; @@ -1754,7 +1783,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; @@ -1895,7 +1925,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ getServices(callback: AsyncCallback>): void; @@ -1942,7 +1973,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ getServices(): Promise>; @@ -2210,7 +2242,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ writeCharacteristicValue( characteristic: BLECharacteristic, @@ -2270,7 +2303,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ writeCharacteristicValue(characteristic: BLECharacteristic, writeType: GattWriteType): Promise; @@ -2323,7 +2357,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ writeDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback): void; @@ -2376,7 +2411,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ writeDescriptorValue(descriptor: BLEDescriptor): Promise; @@ -2405,7 +2441,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getRssiValue(callback: AsyncCallback): void; @@ -2434,7 +2471,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getRssiValue(): Promise; @@ -2481,7 +2519,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ setBLEMtuSize(mtu: number): void; @@ -2518,7 +2557,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setCharacteristicChangeNotification( characteristic: BLECharacteristic, @@ -2559,7 +2599,8 @@ declare namespace ble { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setCharacteristicChangeNotification(characteristic: BLECharacteristic, enable: boolean): Promise; @@ -2666,7 +2707,8 @@ declare namespace ble { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'BLECharacteristicChange', callback: Callback): void; @@ -2695,7 +2737,8 @@ declare namespace ble { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'BLECharacteristicChange', callback?: Callback): void; @@ -2739,7 +2782,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'BLEConnectionStateChange', callback: Callback): void; @@ -2783,7 +2827,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'BLEConnectionStateChange', callback?: Callback): void; @@ -2827,7 +2872,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'BLEMtuChange', callback: Callback): void; @@ -2871,7 +2917,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'BLEMtuChange', callback?: Callback): void; } @@ -2945,7 +2992,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'BLEDeviceFind', callback: Callback): void; /** @@ -2962,7 +3010,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'BLEDeviceFind', callback?: Callback): void; } @@ -2989,7 +3038,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface GattService { /** @@ -3014,7 +3064,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; /** @@ -3039,7 +3090,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ isPrimary: boolean; /** @@ -3064,7 +3116,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristics: Array; /** @@ -3107,7 +3160,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface BLECharacteristic { /** @@ -3132,7 +3186,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; /** @@ -3157,7 +3212,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -3182,7 +3238,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicValue: ArrayBuffer; /** @@ -3207,7 +3264,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ descriptors: Array; /** @@ -3232,7 +3290,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ properties?: GattProperties; /** @@ -3269,7 +3328,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface BLEDescriptor { /** @@ -3294,7 +3354,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; /** @@ -3319,7 +3380,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -3344,7 +3406,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ descriptorUuid: string; /** @@ -3369,7 +3432,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ descriptorValue: ArrayBuffer; /** @@ -3406,7 +3470,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface NotifyCharacteristic { /** @@ -3431,7 +3496,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; /** @@ -3456,7 +3522,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -3481,7 +3548,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicValue: ArrayBuffer; /** @@ -3499,7 +3567,8 @@ declare namespace ble { * @type { boolean } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ confirm: boolean; } @@ -3526,7 +3595,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface CharacteristicReadRequest { /** @@ -3551,7 +3621,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -3576,7 +3647,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ transId: number; /** @@ -3592,7 +3664,8 @@ declare namespace ble { * @type { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; /** @@ -3617,7 +3690,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -3642,7 +3716,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; } @@ -3669,7 +3744,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface CharacteristicWriteRequest { /** @@ -3694,7 +3770,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -3719,7 +3796,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ transId: number; /** @@ -3735,7 +3813,8 @@ declare namespace ble { * @type { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; /** @@ -3792,7 +3871,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ value: ArrayBuffer; /** @@ -3817,7 +3897,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -3842,7 +3923,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; } @@ -3869,7 +3951,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface DescriptorReadRequest { /** @@ -3894,7 +3977,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -3919,7 +4003,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ transId: number; /** @@ -3935,7 +4020,8 @@ declare namespace ble { * @type { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; /** @@ -3960,7 +4046,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ descriptorUuid: string; /** @@ -3985,7 +4072,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -4010,7 +4098,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; } @@ -4037,7 +4126,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface DescriptorWriteRequest { /** @@ -4062,7 +4152,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -4087,7 +4178,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ transId: number; /** @@ -4103,7 +4195,8 @@ declare namespace ble { * @type { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; /** @@ -4160,7 +4253,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ value: ArrayBuffer; /** @@ -4185,7 +4279,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ descriptorUuid: string; /** @@ -4210,7 +4305,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ characteristicUuid: string; /** @@ -4235,7 +4331,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; } @@ -4262,7 +4359,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface ServerResponse { /** @@ -4287,7 +4385,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -4312,7 +4411,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ transId: number; /** @@ -4337,7 +4437,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ status: number; /** @@ -4353,7 +4454,8 @@ declare namespace ble { * @type { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; /** @@ -4378,7 +4480,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ value: ArrayBuffer; } @@ -4405,7 +4508,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface BLEConnectionChangeState { /** @@ -4430,7 +4534,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -4455,7 +4560,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ state: ProfileConnectionState; } @@ -4482,7 +4588,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScanResult { /** @@ -4507,7 +4614,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -4557,7 +4665,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ data: ArrayBuffer; /** @@ -4607,7 +4716,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ connectable: boolean; } @@ -4639,7 +4749,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ scanResult: Array; } @@ -4666,7 +4777,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface AdvertiseSetting { /** @@ -4686,7 +4798,8 @@ declare namespace ble { * @type { ?number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interval?: number; /** @@ -4706,7 +4819,8 @@ declare namespace ble { * @type { ?number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ txPower?: number; /** @@ -4731,7 +4845,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ connectable?: boolean; } @@ -4758,7 +4873,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface AdvertiseData { /** @@ -4783,7 +4899,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuids: Array; /** @@ -4808,7 +4925,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ manufactureData: Array; /** @@ -4833,7 +4951,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceData: Array; /** @@ -4886,7 +5005,8 @@ declare namespace ble { * @typedef AdvertisingParams * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface AdvertisingParams { /** @@ -4902,7 +5022,8 @@ declare namespace ble { * @type { AdvertiseSetting } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ advertisingSettings: AdvertiseSetting; /** @@ -4918,7 +5039,8 @@ declare namespace ble { * @type { AdvertiseData } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ advertisingData: AdvertiseData; /** @@ -4934,7 +5056,8 @@ declare namespace ble { * @type { ?AdvertiseData } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ advertisingResponse?: AdvertiseData; /** @@ -4944,7 +5067,8 @@ declare namespace ble { * * @type { ?number } * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; } @@ -4972,7 +5096,8 @@ declare namespace ble { * * @type { ?number } * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; } @@ -5008,7 +5133,8 @@ declare namespace ble { * @typedef AdvertisingStateChangeInfo * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface AdvertisingStateChangeInfo { /** @@ -5040,7 +5166,8 @@ declare namespace ble { * @type { AdvertisingState } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ state: AdvertisingState; } @@ -5067,7 +5194,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface ManufactureData { /** @@ -5144,7 +5272,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface ServiceData { /** @@ -5169,7 +5298,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid: string; /** @@ -5246,7 +5376,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId?: string; @@ -5298,7 +5429,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceUuid?: string; @@ -5402,7 +5534,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ serviceData?: ArrayBuffer; @@ -5480,7 +5613,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ manufactureData?: ArrayBuffer; @@ -5533,7 +5667,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScanOptions { /** @@ -5558,7 +5693,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interval?: number; /** @@ -5583,7 +5719,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dutyMode?: ScanDuty; /** @@ -5599,7 +5736,8 @@ declare namespace ble { * @type { ?MatchMode } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ matchMode?: MatchMode; /** @@ -5654,7 +5792,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface GattProperties { /** @@ -5679,7 +5818,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ write?: boolean; /** @@ -5704,7 +5844,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ writeNoResponse?: boolean; /** @@ -5729,7 +5870,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ read?: boolean; /** @@ -5754,7 +5896,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ notify?: boolean; /** @@ -5770,7 +5913,8 @@ declare namespace ble { * @type { ?boolean } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ indicate?: boolean; } @@ -5797,7 +5941,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum GattWriteType { /** @@ -5819,7 +5964,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WRITE = 1, /** @@ -5841,7 +5987,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ WRITE_NO_RESPONSE = 2 } @@ -5851,7 +5998,7 @@ declare namespace ble { * * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since 10 */ /** * The enum of scan duty. @@ -5868,7 +6015,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum ScanDuty { /** @@ -5890,7 +6038,8 @@ declare namespace ble { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ SCAN_MODE_LOW_POWER = 0, /** @@ -5952,7 +6101,8 @@ declare namespace ble { * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MatchMode { /** @@ -5966,7 +6116,8 @@ declare namespace ble { * * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MATCH_MODE_AGGRESSIVE = 1, /** @@ -5980,7 +6131,8 @@ declare namespace ble { * * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MATCH_MODE_STICKY = 2 } @@ -5998,7 +6150,8 @@ declare namespace ble { * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum AdvertisingState { /** diff --git a/api/@ohos.bluetooth.connection.d.ts b/api/@ohos.bluetooth.connection.d.ts index 31e245edcf43b465e48a42bd802d8e0dc0d4c3c5..014f7757e21a5fe111ebae2c9f51cb30a6e077d0 100644 --- a/api/@ohos.bluetooth.connection.d.ts +++ b/api/@ohos.bluetooth.connection.d.ts @@ -43,7 +43,8 @@ import type constant from './@ohos.bluetooth.constant'; * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace connection { /** @@ -118,7 +119,8 @@ declare namespace connection { * @typedef { constant.MajorClass } MajorClass * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ type MajorClass = constant.MajorClass; @@ -135,7 +137,8 @@ declare namespace connection { * @typedef { constant.MajorMinorClass } MajorMinorClass * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ type MajorMinorClass = constant.MajorMinorClass; @@ -461,7 +464,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteDeviceName(deviceId: string): string; @@ -480,7 +484,8 @@ declare namespace connection { * @throws { BusinessError } 2900099 - Failed to obtain the name or alias of the peer Bluetooth device. * @syscap SystemCapability.Communication.Bluetooth.Core * @atomicservice - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteDeviceName(deviceId: string, alias?: boolean): string; @@ -530,7 +535,8 @@ declare namespace connection { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteDeviceClass(deviceId: string): DeviceClass; @@ -601,7 +607,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function getPairedDevices(): Array; @@ -747,7 +754,8 @@ declare namespace connection { * @throws { BusinessError } 2900003 - Bluetooth disabled. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function setBluetoothScanMode(mode: ScanMode, duration: number): void; @@ -1169,7 +1177,8 @@ declare namespace connection { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteProductId(deviceId: string): string; @@ -1360,7 +1369,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'bluetoothDeviceFind', callback: Callback>): void; @@ -1401,7 +1411,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'bluetoothDeviceFind', callback?: Callback>): void; @@ -1432,7 +1443,8 @@ declare namespace connection { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'discoveryResult', callback: Callback>): void; @@ -1459,7 +1471,8 @@ declare namespace connection { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'discoveryResult', callback?: Callback>): void; @@ -1490,7 +1503,8 @@ declare namespace connection { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'bondStateChange', callback: Callback): void; @@ -1521,7 +1535,8 @@ declare namespace connection { * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'bondStateChange', callback?: Callback): void; @@ -1537,7 +1552,8 @@ declare namespace connection { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'pinRequired', callback: Callback): void; @@ -1553,7 +1569,8 @@ declare namespace connection { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'pinRequired', callback?: Callback): void; @@ -1566,7 +1583,8 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'batteryChange', callback: Callback): void; @@ -1579,7 +1597,8 @@ declare namespace connection { * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2900099 - Operation failed. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'batteryChange', callback?: Callback): void; @@ -1596,7 +1615,8 @@ declare namespace connection { * @typedef BondStateParam * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface BondStateParam { /** @@ -1612,7 +1632,8 @@ declare namespace connection { * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -1628,7 +1649,8 @@ declare namespace connection { * @type { BondState } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ state: BondState; /** @@ -1654,7 +1676,8 @@ declare namespace connection { * * @typedef PinRequiredParam * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PinRequiredParam { /** @@ -1662,7 +1685,8 @@ declare namespace connection { * * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -1697,7 +1721,8 @@ declare namespace connection { * @typedef DeviceClass * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface DeviceClass { /** @@ -1713,7 +1738,8 @@ declare namespace connection { * @type { MajorClass } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ majorClass: MajorClass; /** @@ -1729,7 +1755,8 @@ declare namespace connection { * @type { MajorMinorClass } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ majorMinorClass: MajorMinorClass; /** @@ -1787,7 +1814,8 @@ declare namespace connection { * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum ScanMode { /** @@ -1843,7 +1871,8 @@ declare namespace connection { * * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE = 4, /** @@ -1877,7 +1906,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum BondState { /** @@ -1943,7 +1973,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ BOND_STATE_BONDED = 2 } @@ -2036,7 +2067,8 @@ declare namespace connection { * * @typedef DiscoveryResult * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface DiscoveryResult { /** @@ -2052,7 +2084,8 @@ declare namespace connection { * * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -2110,7 +2143,8 @@ declare namespace connection { * * @typedef BatteryInfo * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface BatteryInfo { /** @@ -2119,7 +2153,8 @@ declare namespace connection { * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** @@ -2367,7 +2402,8 @@ declare namespace connection { * @type { string } * @syscap SystemCapability.Communication.Bluetooth.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; /** diff --git a/api/@ohos.bluetooth.constant.d.ts b/api/@ohos.bluetooth.constant.d.ts index 5d460b0103a3fc8dd7d08ef5d60ff8878c0d1cdb..bd23efaecced64962ca4b5d510518f3067658ac5 100644 --- a/api/@ohos.bluetooth.constant.d.ts +++ b/api/@ohos.bluetooth.constant.d.ts @@ -18,6 +18,7 @@ * @kit ConnectivityKit */ + /** * The definition of constant. * @@ -40,7 +41,8 @@ * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace constant { /** @@ -364,7 +366,8 @@ declare namespace constant { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ export enum ProfileConnectionState { /** @@ -386,7 +389,8 @@ declare namespace constant { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_DISCONNECTED = 0, /** @@ -430,7 +434,8 @@ declare namespace constant { * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_CONNECTED = 2, /** @@ -470,7 +475,8 @@ declare namespace constant { * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ export enum MajorClass { /** @@ -491,7 +497,8 @@ declare namespace constant { * Mobile phone. * * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ MAJOR_PHONE = 0x0200, /** @@ -512,7 +519,8 @@ declare namespace constant { * * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ MAJOR_AUDIO_VIDEO = 0x0400, /** @@ -561,7 +569,8 @@ declare namespace constant { * Unclassified device. * * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ MAJOR_UNCATEGORIZED = 0x1F00 } @@ -579,7 +588,8 @@ declare namespace constant { * @enum { number } * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ export enum MajorMinorClass { /** @@ -850,7 +860,8 @@ declare namespace constant { * * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_VIDEO_WEARABLE_HEADSET = 0x0404, /** @@ -892,7 +903,8 @@ declare namespace constant { * * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_VIDEO_LOUDSPEAKER = 0x0414, /** @@ -906,7 +918,8 @@ declare namespace constant { * * @syscap SystemCapability.Communication.Bluetooth.Core * @crossplatform - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_VIDEO_HEADPHONES = 0x0418, /** diff --git a/api/@ohos.bluetooth.hfp.d.ts b/api/@ohos.bluetooth.hfp.d.ts index f9c60496319bcbfcd8005a1b058563e83b5877ed..53e4c633c3d7edf20edccbf303ff0fbb73146a75 100644 --- a/api/@ohos.bluetooth.hfp.d.ts +++ b/api/@ohos.bluetooth.hfp.d.ts @@ -25,7 +25,8 @@ import type baseProfile from './@ohos.bluetooth.baseProfile'; * * @namespace hfp * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace hfp { /** @@ -33,7 +34,8 @@ declare namespace hfp { * * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type BaseProfile = baseProfile.BaseProfile; @@ -45,7 +47,8 @@ declare namespace hfp { *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function createHfpAgProfile(): HandsFreeAudioGatewayProfile; @@ -55,7 +58,8 @@ declare namespace hfp { * @extends BaseProfile * @typedef HandsFreeAudioGatewayProfile * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface HandsFreeAudioGatewayProfile extends BaseProfile { /** diff --git a/api/@ohos.bluetooth.hid.d.ts b/api/@ohos.bluetooth.hid.d.ts index 317f129d415e1b61142ce60e903f7bbedd20751c..7375d037445efd9c4115eb0dc9e266d4c435b89f 100644 --- a/api/@ohos.bluetooth.hid.d.ts +++ b/api/@ohos.bluetooth.hid.d.ts @@ -25,7 +25,8 @@ import type baseProfile from './@ohos.bluetooth.baseProfile'; * * @namespace hid * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace hid { /** @@ -33,7 +34,8 @@ declare namespace hid { * * @typedef { baseProfile.BaseProfile } BaseProfile * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type BaseProfile = baseProfile.BaseProfile; @@ -45,7 +47,8 @@ declare namespace hid { *
2. Incorrect parameter types. 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function createHidHostProfile(): HidHostProfile; @@ -55,7 +58,8 @@ declare namespace hid { * @extends BaseProfile * @typedef HidHostProfile * @syscap SystemCapability.Communication.Bluetooth.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface HidHostProfile extends BaseProfile { /** diff --git a/api/@ohos.brightness.d.ts b/api/@ohos.brightness.d.ts index 9b8807e0b0d7413d60670c8fa88649f1676e6440..86a55c05f46769f25c81753d6ff84901d3b2e4fc 100644 --- a/api/@ohos.brightness.d.ts +++ b/api/@ohos.brightness.d.ts @@ -16,9 +16,13 @@ /** * @file * @kit BasicServicesKit + * @arkts 1.1&1.2 */ import { BusinessError } from './@ohos.base'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ /** * Provides interfaces to control the power of display. @@ -26,29 +30,29 @@ import { BusinessError } from './@ohos.base'; * @namespace brightness * @syscap SystemCapability.PowerManager.DisplayPowerManager * @systemapi - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} */ declare namespace brightness { /** * Sets the screen brightness. * - * @param { number } value Brightness value, ranging from 0 to 255. - * value parameter must be of type number. + * @param { int } value Brightness value, ranging from 0 to 255. + * value parameter must be of type int. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; * 2. Incorrect parameter types; * @throws { BusinessError } 4700101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.DisplayPowerManager * @systemapi - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} */ - function setValue(value: number): void; + function setValue(value: int): void; /** * Sets the screen brightness. * - * @param { number } value - Brightness value, ranging from 0 to 255. - * value parameter must be of type number. + * @param { int } value - Brightness value, ranging from 0 to 255. + * value parameter must be of type int. * @param { boolean } continuous - This parameter is used in the scenario of continuous adjustment to the brightness. * You are advised to set this parameter to true during the continuous adjustment and * to false at the end of the continuous adjustment for better performance. @@ -59,8 +63,8 @@ declare namespace brightness { * @throws { BusinessError } 4700101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.DisplayPowerManager * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ - function setValue(value: number, continuous: boolean): void; + function setValue(value: int, continuous: boolean): void; } export default brightness; diff --git a/api/@ohos.buffer.d.ts b/api/@ohos.buffer.d.ts index 891377d32185db18d4efbfbbc3f8dba25fd66af8..5052e2092986a0c1f157fb04036fe7f3b758b45d 100644 --- a/api/@ohos.buffer.d.ts +++ b/api/@ohos.buffer.d.ts @@ -40,7 +40,8 @@ * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace buffer { /** @@ -65,7 +66,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type BufferEncoding = | 'ascii' @@ -103,6 +105,27 @@ declare namespace buffer { * @since 11 */ interface TypedArray extends Int8Array {} + /** + * TypedArray features and methods + * + * @typedef { Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | BigInt64Array | BigUint64Array } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type TypedArray = Int8Array + | Uint8Array + | Uint8ClampedArray + | Int16Array + | Uint16Array + | Int32Array + | Uint32Array + | Float32Array + | Float64Array + | BigInt64Array + | BigUint64Array; /** * Allocates a new Buffer for a fixed size bytes. If fill is undefined, the Buffer will be zero-filled. * @@ -146,7 +169,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer; @@ -187,7 +211,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function allocUninitializedFromPool(size: number): Buffer; @@ -228,7 +253,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function allocUninitialized(size: number): Buffer; @@ -282,6 +308,25 @@ declare namespace buffer { encoding?: BufferEncoding ): number; + /** + * Returns the byte length of a string when encoded using `encoding`. + * This is not the same as [`String.prototype.length`], which does not account + * for the encoding that is used to convert the string into bytes. + * + * @param { string | Buffer | TypedArray | DataView | ArrayBuffer } doc - string string A value to calculate the length of + * @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] If `string` is a string, this is its encoding + * @returns { number } The number of bytes contained within `string` + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + function byteLength( + doc: string | Buffer | TypedArray | DataView | ArrayBuffer, + encoding?: BufferEncoding + ): number; + /** * Returns a new `Buffer` which is the result of concatenating all the `Buffer`instances in the `list` together. * @@ -325,7 +370,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function concat(list: Buffer[] | Uint8Array[], totalLength?: number): Buffer; @@ -363,7 +409,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function from(array: number[]): Buffer; @@ -420,6 +467,23 @@ declare namespace buffer { */ function from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): Buffer; + /** + * This creates a view of the ArrayBuffer without copying the underlying memory. + * + * @param { ArrayBuffer } arrayBuffer - arrayBuffer arrayBuffer An ArrayBuffer, + * @param { number } [byteOffset] - byteOffset [byteOffset = 0] Index of first byte to expose + * @param { number } [length] - length [length = arrayBuffer.byteLength - byteOffset] Number of bytes to expose + * @returns { Buffer } Return a view of the ArrayBuffer + * @throws { BusinessError } 10200001 - The value of "[byteOffset/length]" is out of range. + * It must be >= [left range] and <= [right range]. Received value is: [byteOffset/length] + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + function from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer; + /** * Copies the passed buffer data onto a new Buffer instance. * @@ -454,7 +518,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function from(buffer: Buffer | Uint8Array): Buffer; @@ -501,7 +566,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function from(object: Object, offsetOrEncoding: number | string, length: number): Buffer; @@ -545,7 +611,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function from(string: String, encoding?: BufferEncoding): Buffer; @@ -574,7 +641,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function isBuffer(obj: Object): boolean; @@ -603,7 +671,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function isEncoding(encoding: string): boolean; @@ -654,6 +723,22 @@ declare namespace buffer { */ function compare(buf1: Buffer | Uint8Array, buf2: Buffer | Uint8Array): -1 | 0 | 1; + /** + * Compares buf1 to buf2 + * + * @param { Buffer | Uint8Array } buf1 - buf1 buf1 A Buffer or Uint8Array instance. + * @param { Buffer | Uint8Array } buf2 - buf2 buf2 A Buffer or Uint8Array instance. + * @returns { number } 0 is returned if target is the same as buf + * 1 is returned if target should come before buf when sorted. + * -1 is returned if target should come after buf when sorted. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + function compare(buf1: Buffer | Uint8Array, buf2: Buffer | Uint8Array): number; + /** * Re-encodes the given Buffer or Uint8Array instance from one character encoding to another. * @@ -694,7 +779,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function transcode(source: Buffer | Uint8Array, fromEnc: string, toEnc: string): Buffer; @@ -718,7 +804,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class Buffer { /** @@ -750,6 +837,18 @@ declare namespace buffer { */ length: number; + /** + * Gets the element number of the buffer. + * + * @type { number } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get length(): number; + /** * The underlying ArrayBuffer object based on which this Buffer object is created. * @@ -779,6 +878,19 @@ declare namespace buffer { */ buffer: ArrayBuffer; + /** + * The underlying ArrayBuffer object based on which this Buffer object is created. + * + * @type { ArrayBuffer } + * @throws { BusinessError } 10200013 - Buffer cannot be set for the buffer that has only a getter. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get buffer(): ArrayBuffer; + /** * The byteOffset of the Buffers underlying ArrayBuffer object * @@ -808,6 +920,19 @@ declare namespace buffer { */ byteOffset: number; + /** + * The byteOffset of the Buffers underlying ArrayBuffer object + * + * @type { number } + * @throws { BusinessError } 10200013 - ByteOffset cannot be set for the buffer that has only a getter. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get byteOffset(): number; + /** * Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled. * @@ -854,7 +979,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ fill( value: string | Buffer | Uint8Array | number, @@ -934,6 +1060,35 @@ declare namespace buffer { sourceEnd?: number ): -1 | 0 | 1; + /** + * Compares buf with target and returns a number indicating whether buf comes before, after, + * or is the same as target in sort order. Comparison is based on the actual sequence of bytes in each Buffer. + * + * @param { Buffer | Uint8Array } target - target target A Buffer or Uint8Array with which to compare buf + * @param { number } [targetStart] - targetStart [targetStart = 0] The offset within target at which to begin comparison + * @param { number } [targetEnd] - targetEnd [targetEnd = target.length] The offset within target at which to end comparison (not inclusive) + * @param { number } [sourceStart] - sourceStart [sourceStart = 0] The offset within buf at which to begin comparison + * @param { number } [sourceEnd] - sourceEnd [sourceEnd = buf.length] The offset within buf at which to end comparison (not inclusive) + * @returns { number } number is returned if target is the same as buf + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @throws { BusinessError } 10200001 - The value of "[targetStart/targetEnd/sourceStart/sourceEnd]" is out of range. + * It must be >= 0 and <= [right range]. Received value is: [targetStart/targetEnd/sourceStart/sourceEnd] + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + compare( + target: Buffer | Uint8Array, + targetStart?: number, + targetEnd?: number, + sourceStart?: number, + sourceEnd?: number + ): number; + /** * Copies data from a region of buf to a region in target, even if the target memory region overlaps with buf. * If sourceEnd is greater than the length of the target, the length of the target shall prevail, and the extra part will not be overwritten. @@ -986,7 +1141,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ copy(target: Buffer | Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; @@ -1018,7 +1174,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ equals(otherBuffer: Uint8Array | Buffer): boolean; @@ -1062,7 +1219,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ includes(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): boolean; @@ -1109,7 +1267,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ indexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number; @@ -1135,7 +1294,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ keys(): IterableIterator; @@ -1161,7 +1321,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ values(): IterableIterator; @@ -1187,7 +1348,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ entries(): IterableIterator<[number, number]>; @@ -1234,7 +1396,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ lastIndexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number; @@ -1269,7 +1432,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readBigInt64BE(offset?: number): bigint; @@ -1304,7 +1468,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readBigInt64LE(offset?: number): bigint; @@ -1339,7 +1504,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readBigUInt64BE(offset?: number): bigint; @@ -1374,7 +1540,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readBigUInt64LE(offset?: number): bigint; @@ -1409,7 +1576,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readDoubleBE(offset?: number): number; @@ -1444,7 +1612,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readDoubleLE(offset?: number): number; @@ -1479,7 +1648,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readFloatBE(offset?: number): number; @@ -1514,7 +1684,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readFloatLE(offset?: number): number; @@ -1549,7 +1720,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readInt8(offset?: number): number; @@ -1584,7 +1756,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readInt16BE(offset?: number): number; @@ -1619,7 +1792,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readInt16LE(offset?: number): number; @@ -1654,7 +1828,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readInt32BE(offset?: number): number; @@ -1689,7 +1864,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readInt32LE(offset?: number): number; @@ -1736,7 +1912,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readIntBE(offset: number, byteLength: number): number; @@ -1783,7 +1960,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readIntLE(offset: number, byteLength: number): number; @@ -1818,7 +1996,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUInt8(offset?: number): number; @@ -1853,7 +2032,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUInt16BE(offset?: number): number; @@ -1888,7 +2068,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUInt16LE(offset?: number): number; @@ -1923,7 +2104,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUInt32BE(offset?: number): number; @@ -1958,7 +2140,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUInt32LE(offset?: number): number; @@ -2005,7 +2188,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUIntBE(offset: number, byteLength: number): number; @@ -2052,7 +2236,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ readUIntLE(offset: number, byteLength: number): number; @@ -2084,7 +2269,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ subarray(start?: number, end?: number): Buffer; @@ -2113,7 +2299,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ swap16(): Buffer; @@ -2142,7 +2329,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ swap32(): Buffer; @@ -2171,7 +2359,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ swap64(): Buffer; @@ -2239,6 +2428,21 @@ declare namespace buffer { */ toString(encoding?: string, start?: number, end?: number): string; + /** + * Decodes buf to a string according to the specified character encoding in encoding + * + * @param { BufferEncoding } [encoding] - encoding [encoding='utf8'] The character encoding to use + * @param { number } [start] - start [start = 0] The byte offset to start decoding at + * @param { number } [end] - end [end = buf.length] The byte offset to stop decoding at (not inclusive) + * @returns { string } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + toString(encoding?: BufferEncoding, start?: number, end?: number): string; + /** * Writes string to buf at offset according to the character encoding in encoding * @@ -2285,7 +2489,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ write(str: string, offset?: number, length?: number, encoding?: string): number; @@ -2331,7 +2536,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeBigInt64BE(value: bigint, offset?: number): number; @@ -2378,7 +2584,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeBigInt64LE(value: bigint, offset?: number): number; @@ -2425,7 +2632,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeBigUInt64BE(value: bigint, offset?: number): number; @@ -2472,7 +2680,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeBigUInt64LE(value: bigint, offset?: number): number; @@ -2516,7 +2725,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeDoubleBE(value: number, offset?: number): number; @@ -2560,7 +2770,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeDoubleLE(value: number, offset?: number): number; @@ -2604,7 +2815,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeFloatBE(value: number, offset?: number): number; @@ -2648,7 +2860,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeFloatLE(value: number, offset?: number): number; @@ -2695,7 +2908,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeInt8(value: number, offset?: number): number; @@ -2742,7 +2956,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeInt16BE(value: number, offset?: number): number; @@ -2789,7 +3004,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeInt16LE(value: number, offset?: number): number; @@ -2836,7 +3052,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeInt32BE(value: number, offset?: number): number; @@ -2883,7 +3100,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeInt32LE(value: number, offset?: number): number; @@ -2930,7 +3148,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeIntBE(value: number, offset: number, byteLength: number): number; @@ -2977,7 +3196,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeIntLE(value: number, offset: number, byteLength: number): number; @@ -3024,7 +3244,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUInt8(value: number, offset?: number): number; @@ -3071,7 +3292,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUInt16BE(value: number, offset?: number): number; @@ -3118,7 +3340,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUInt16LE(value: number, offset?: number): number; @@ -3165,7 +3388,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUInt32BE(value: number, offset?: number): number; @@ -3212,7 +3436,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUInt32LE(value: number, offset?: number): number; @@ -3259,7 +3484,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUIntBE(value: number, offset: number, byteLength: number): number; @@ -3306,9 +3532,70 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ writeUIntLE(value: number, offset: number, byteLength: number): number; + + /** + * Returns the byte at the specified index. + * + * @param { number } index - byte index to read + * @returns { number | undefined } Returns the byte value at `index` + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + $_get(index: number): number | undefined; + + /** + * Sets the byte at the specified index. + * + * @param { number } index – byte index to write + * @param { number } value – byte value (0–255) + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + $_set(index: number, value: number): void; + } + + /** + * Defines the Blob related options parameters. + * + * @interface BlobOptions + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + interface BlobOptions { + /** + * Blob content type. The default parameter is' '. + * @type { ?string } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type?: string; + + /** + * How to output a string ending with '\ n' as' transparent or native . The default value is transparent. + * @type { ?string } + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + endings?: string; } /** @@ -3330,7 +3617,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class Blob { /** @@ -3380,6 +3668,25 @@ declare namespace buffer { */ constructor(sources: string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[], options?: Object); + /** + * Creates a new Blob object containing a concatenation of the given sources. + * + * @param { Array | Array | Array | Array | Array } sources - sources sources An array of string, , + * , , or objects, or any mix of such objects, that will be stored within the Blob + * @param { BlobOptions } [options] - options options {endings: string, type: string} + * endings: One of either 'transparent' or 'native'. + * type: The Blob content-type + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1.Mandatory parameters are left unspecified; + * 2.Incorrect parameter types. + * @syscap SystemCapability.Utils.Lang + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + constructor(sources: Array | Array | Array | Array | Array, options?: BlobOptions); + /** * The total size of the Blob in bytes * @@ -3402,7 +3709,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ size: number; @@ -3428,7 +3736,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type: string; @@ -3454,7 +3763,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ arrayBuffer(): Promise; @@ -3489,7 +3799,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ slice(start?: number, end?: number, type?: string): Blob; @@ -3515,7 +3826,8 @@ declare namespace buffer { * @syscap SystemCapability.Utils.Lang * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ text(): Promise; } diff --git a/api/@ohos.bundle.appControl.d.ts b/api/@ohos.bundle.appControl.d.ts index cb2e1abe8306f31a21cca5b3800727d108133c37..37d99c504ad823fd7766b428a2852fd338d744c3 100644 --- a/api/@ohos.bundle.appControl.d.ts +++ b/api/@ohos.bundle.appControl.d.ts @@ -19,7 +19,12 @@ */ import { AsyncCallback } from './@ohos.base'; +/*** if arkts 1.1 */ import type { ElementName } from './bundleManager/ElementName'; +/*** endif */ +/*** if arkts 1.2 */ +import { ElementName } from './bundleManager/ElementName'; +/*** endif */ import Want from './@ohos.app.ability.Want'; /** @@ -28,7 +33,8 @@ import Want from './@ohos.app.ability.Want'; * @namespace appControl * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace appControl { /** @@ -37,7 +43,8 @@ declare namespace appControl { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ComponentType { /** @@ -45,7 +52,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UI_ABILITY = 1, @@ -54,7 +62,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UI_EXTENSION = 2 } @@ -65,7 +74,8 @@ declare namespace appControl { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum UninstallComponentType { /** @@ -73,7 +83,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ EXTENSION = 1, } @@ -84,7 +95,8 @@ declare namespace appControl { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum DisposedType { /** @@ -92,7 +104,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ BLOCK_APPLICATION = 1, /** @@ -100,7 +113,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ BLOCK_ABILITY = 2, /** @@ -108,7 +122,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NON_BLOCK = 3 } @@ -119,7 +134,8 @@ declare namespace appControl { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ControlType { /** @@ -127,7 +143,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ALLOWED_LIST = 1, /** @@ -135,7 +152,8 @@ declare namespace appControl { * * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DISALLOWED_LIST = 2 } @@ -146,7 +164,8 @@ declare namespace appControl { * @typedef DisposedRule * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface DisposedRule { /** @@ -155,7 +174,8 @@ declare namespace appControl { * @type { Want } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ want: Want; @@ -165,7 +185,8 @@ declare namespace appControl { * @type { ComponentType } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ componentType: ComponentType; @@ -175,7 +196,8 @@ declare namespace appControl { * @type { DisposedType } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ disposedType: DisposedType; @@ -185,7 +207,8 @@ declare namespace appControl { * @type { ControlType } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ controlType: ControlType; @@ -195,9 +218,10 @@ declare namespace appControl { * @type { Array } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - elementList: Array ; + elementList: Array; /** * Indicates priority of the rule. @@ -205,7 +229,8 @@ declare namespace appControl { * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ priority: number; } @@ -216,7 +241,8 @@ declare namespace appControl { * @typedef UninstallDisposedRule * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface UninstallDisposedRule { /** @@ -225,7 +251,8 @@ declare namespace appControl { * @type { Want } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ want: Want; @@ -235,7 +262,8 @@ declare namespace appControl { * @type { UninstallComponentType } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstallComponentType: UninstallComponentType; @@ -245,7 +273,8 @@ declare namespace appControl { * @type { number } * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ priority: number; } @@ -264,7 +293,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDisposedStatus(appId: string, disposedWant: Want, callback: AsyncCallback): void; @@ -282,7 +312,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDisposedStatus(appId: string, disposedWant: Want): Promise; @@ -299,7 +330,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDisposedStatusSync(appId: string, disposedWant: Want): void; @@ -316,7 +348,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDisposedStatus(appId: string, callback: AsyncCallback): void; @@ -333,7 +366,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDisposedStatus(appId: string): Promise; @@ -350,7 +384,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDisposedStatusSync(appId: string): Want; @@ -367,7 +402,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteDisposedStatus(appId: string, callback: AsyncCallback): void; @@ -384,7 +420,8 @@ declare namespace appControl { * @throws { BusinessError } 17700005 - The specified app ID is empty string. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteDisposedStatus(appId: string): Promise; @@ -416,7 +453,8 @@ declare namespace appControl { * @throws { BusinessError } 17700061 - AppIndex is not in the valid range. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteDisposedStatusSync(appId: string, appIndex?: number): void; @@ -450,7 +488,8 @@ declare namespace appControl { * @throws { BusinessError } 17700061 - AppIndex is not in the valid range. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDisposedRule(appId: string, appIndex?: number): DisposedRule; @@ -484,9 +523,10 @@ declare namespace appControl { * @throws { BusinessError } 17700061 - AppIndex is not in the valid range. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setDisposedRule(appId: string, rule: DisposedRule, appIndex?: number): void; + function setDisposedRule(appId: string, rule: DisposedRule, appIndex?: number): void; /** * Sets the uninstall disposed rule of a specified bundle. @@ -504,7 +544,8 @@ declare namespace appControl { * @throws { BusinessError } 17700075 - The specified bundleName of want is not the same with caller. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function setUninstallDisposedRule(appIdentifier: string, rule: UninstallDisposedRule, appIndex?: number): void; @@ -523,7 +564,8 @@ declare namespace appControl { * @throws { BusinessError } 17700074 - The specified appIdentifier is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUninstallDisposedRule(appIdentifier: string, appIndex?: number): UninstallDisposedRule; @@ -541,7 +583,8 @@ declare namespace appControl { * @throws { BusinessError } 17700074 - The specified appIdentifier is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.AppControl * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteUninstallDisposedRule(appIdentifier: string, appIndex?: number): void; } diff --git a/api/@ohos.bundle.bundleManager.d.ts b/api/@ohos.bundle.bundleManager.d.ts index f3ad4343b06469c7201ff0f6bd2e9ae8b86f1656..d1093417e7bc98a9828b5f27dbe90eeacdbaeb9f 100644 --- a/api/@ohos.bundle.bundleManager.d.ts +++ b/api/@ohos.bundle.bundleManager.d.ts @@ -19,21 +19,34 @@ */ import { AsyncCallback } from './@ohos.base'; +import { Metadata as _Metadata } from './bundleManager/Metadata'; +import { ElementName as _ElementName } from './bundleManager/ElementName'; +import Want from './@ohos.app.ability.Want'; +/*** if arkts 1.1 */ import type { ApplicationInfo as _ApplicationInfo, ModuleMetadata as _ModuleMetadata, PreinstalledApplicationInfo as _PreinstalledApplicationInfo } from './bundleManager/ApplicationInfo'; -import { Metadata as _Metadata } from './bundleManager/Metadata'; import { PermissionDef as _PermissionDef } from './bundleManager/PermissionDef'; import { PluginBundleInfo as _PluginBundleInfo, PluginModuleInfo as _PluginModuleInfo} from './bundleManager/PluginBundleInfo'; -import { ElementName as _ElementName } from './bundleManager/ElementName'; import { SharedBundleInfo as _SharedBundleInfo } from './bundleManager/SharedBundleInfo'; import type { RecoverableApplicationInfo as _RecoverableApplicationInfo } from './bundleManager/RecoverableApplicationInfo'; -import Want from './@ohos.app.ability.Want'; import * as _AbilityInfo from './bundleManager/AbilityInfo'; import * as _AppProvisionInfo from './bundleManager/AppProvisionInfo'; import * as _BundleInfo from './bundleManager/BundleInfo'; import * as _HapModuleInfo from './bundleManager/HapModuleInfo'; import * as _ExtensionAbilityInfo from './bundleManager/ExtensionAbilityInfo'; import * as _Skill from './bundleManager/Skill'; +/*** endif */ +/*** if arkts 1.2 */ +import { ApplicationInfo as _ApplicationInfo, ModuleMetadata as _ModuleMetadata, + PreinstalledApplicationInfo as _PreinstalledApplicationInfo } from './bundleManager/ApplicationInfo'; +import { AbilityInfo as _AbilityInfo, WindowSize as _WindowSize } from './bundleManager/AbilityInfo'; +import { BundleInfo as _BundleInfo, UsedScene as _UsedScene, ReqPermissionDetail as _ReqPermissionDetail, + SignatureInfo as _SignatureInfo, AppCloneIdentity as _AppCloneIdentity } from './bundleManager/BundleInfo'; +import { HapModuleInfo as _HapModuleInfo, PreloadItem as _PreloadItem, Dependency as _Dependency, + RouterItem as _RouterItem, DataItem as _DataItem } from './bundleManager/HapModuleInfo'; +import { ExtensionAbilityInfo as _ExtensionAbilityInfo } from './bundleManager/ExtensionAbilityInfo'; +import { Skill as _Skill, SkillUri as _SkillUri } from './bundleManager/Skill'; +/*** endif */ /** * This module is used to obtain package information of various applications installed on the current device. * @@ -56,7 +69,8 @@ import * as _Skill from './bundleManager/Skill'; * @syscap SystemCapability.BundleManager.BundleFramework.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace bundleManager { /** @@ -72,7 +86,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum BundleFlag { /** @@ -88,7 +103,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_DEFAULT = 0x00000000, /** @@ -104,7 +120,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_APPLICATION = 0x00000001, /** @@ -120,7 +137,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_HAP_MODULE = 0x00000002, /** @@ -138,7 +156,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_ABILITY = 0x00000004, /** @@ -156,7 +175,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_EXTENSION_ABILITY = 0x00000008, /** @@ -172,7 +192,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_REQUESTED_PERMISSION = 0x00000010, /** @@ -190,7 +211,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_METADATA = 0x00000020, /** @@ -208,7 +230,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_DISABLE = 0x00000040, /** @@ -224,7 +247,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_SIGNATURE_INFO = 0x00000080, /** @@ -234,7 +258,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_MENU = 0x00000100, /** @@ -244,7 +269,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_ROUTER_MAP = 0x00000200, /** @@ -254,7 +280,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_WITH_SKILL = 0x00000800, /** @@ -263,7 +290,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_ONLY_WITH_LAUNCHER_ABILITY = 0x00001000, /** @@ -271,7 +299,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_OF_ANY_USER = 0x00002000, /** @@ -280,7 +309,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_INFO_EXCLUDE_CLONE = 0x00004000, } @@ -291,7 +321,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ApplicationFlag { /** @@ -300,7 +331,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_APPLICATION_INFO_DEFAULT = 0x00000000, /** @@ -308,7 +340,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_APPLICATION_INFO_WITH_PERMISSION = 0x00000001, /** @@ -316,7 +349,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_APPLICATION_INFO_WITH_METADATA = 0x00000002, /** @@ -324,7 +358,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_APPLICATION_INFO_WITH_DISABLE = 0x00000004 } @@ -335,7 +370,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum AbilityFlag { /** @@ -344,7 +380,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_DEFAULT = 0x00000000, /** @@ -352,7 +389,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_PERMISSION = 0x00000001, /** @@ -360,7 +398,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_APPLICATION = 0x00000002, /** @@ -368,7 +407,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_METADATA = 0x00000004, /** @@ -376,7 +416,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_DISABLE = 0x00000008, /** @@ -391,7 +432,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_ONLY_SYSTEM_APP = 0x00000010, /** @@ -399,7 +441,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_APP_LINKING = 0x00000040, /** @@ -407,7 +450,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_ABILITY_INFO_WITH_SKILL = 0x00000080, } @@ -418,7 +462,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ExtensionAbilityFlag { /** @@ -427,7 +472,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_EXTENSION_ABILITY_INFO_DEFAULT = 0x00000000, /** @@ -435,7 +481,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_EXTENSION_ABILITY_INFO_WITH_PERMISSION = 0x00000001, /** @@ -443,7 +490,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_EXTENSION_ABILITY_INFO_WITH_APPLICATION = 0x00000002, /** @@ -451,7 +499,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_EXTENSION_ABILITY_INFO_WITH_METADATA = 0x00000004, /** @@ -459,7 +508,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_EXTENSION_ABILITY_INFO_WITH_SKILL = 0x00000010, } @@ -477,21 +527,24 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ExtensionAbilityType { /** * Indicates extension info with type of form * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Indicates extension info with type of form * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FORM = 0, @@ -499,7 +552,8 @@ declare namespace bundleManager { * Indicates extension info with type of work schedule * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ WORK_SCHEDULER = 1, @@ -507,7 +561,8 @@ declare namespace bundleManager { * Indicates extension info with type of input method * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ INPUT_METHOD = 2, @@ -515,7 +570,8 @@ declare namespace bundleManager { * Indicates extension info with type of service * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SERVICE = 3, @@ -523,7 +579,8 @@ declare namespace bundleManager { * Indicates extension info with type of accessibility * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACCESSIBILITY = 4, @@ -531,7 +588,8 @@ declare namespace bundleManager { * Indicates extension info with type of dataShare * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DATA_SHARE = 5, @@ -539,7 +597,8 @@ declare namespace bundleManager { * Indicates extension info with type of filesShare * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ FILE_SHARE = 6, @@ -547,7 +606,8 @@ declare namespace bundleManager { * Indicates extension info with type of staticSubscriber * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ STATIC_SUBSCRIBER = 7, @@ -555,7 +615,8 @@ declare namespace bundleManager { * Indicates extension info with type of wallpaper * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ WALLPAPER = 8, @@ -563,7 +624,8 @@ declare namespace bundleManager { * Indicates extension info with type of backup * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ BACKUP = 9, @@ -571,7 +633,8 @@ declare namespace bundleManager { * Indicates extension info with type of window * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOW = 10, @@ -579,7 +642,8 @@ declare namespace bundleManager { * Indicates extension info with type of enterprise admin * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTERPRISE_ADMIN = 11, @@ -587,7 +651,8 @@ declare namespace bundleManager { * Indicates extension info with type of thumbnail * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ THUMBNAIL = 13, @@ -595,7 +660,8 @@ declare namespace bundleManager { * Indicates extension info with type of preview * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW = 14, @@ -603,7 +669,8 @@ declare namespace bundleManager { * Indicates extension info with type of print * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ PRINT = 15, @@ -611,7 +678,8 @@ declare namespace bundleManager { * Indicates extension info with type of share * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SHARE = 16, @@ -619,7 +687,8 @@ declare namespace bundleManager { * Indicates extension info with type of push * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ PUSH = 17, @@ -627,7 +696,8 @@ declare namespace bundleManager { * Indicates extension info with type of driver * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ DRIVER = 18, @@ -635,7 +705,8 @@ declare namespace bundleManager { * Indicates extension info with type of action * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION = 19, @@ -643,7 +714,8 @@ declare namespace bundleManager { * Indicates extension info with type of ads service * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ADS_SERVICE = 20, @@ -651,7 +723,8 @@ declare namespace bundleManager { * Indicates extension info with type of embedded UI * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED_UI = 21, @@ -659,23 +732,44 @@ declare namespace bundleManager { * Indicates extension info with type of insight intent UI * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INSIGHT_INTENT_UI = 22, + /** + * Indicates extension info with type of FENCE + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + FENCE = 24, + /** * Indicates extension info with type of asset acceleration * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_ACCELERATION = 26, + /** + * Indicates extension info with type of form edit + * + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ + FORM_EDIT = 27, + /** * Indicates extension info with type of distributed * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ DISTRIBUTED = 28, @@ -683,7 +777,8 @@ declare namespace bundleManager { * Indicates extension info with type of unspecified * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ UNSPECIFIED = 255 } @@ -701,7 +796,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PermissionGrantState { /** @@ -715,7 +811,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PERMISSION_DENIED = -1, @@ -730,7 +827,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PERMISSION_GRANTED = 0 } @@ -748,7 +846,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum SupportWindowMode { /** @@ -762,7 +861,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FULL_SCREEN = 0, /** @@ -776,7 +876,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SPLIT = 1, /** @@ -790,7 +891,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLOATING = 2 } @@ -817,7 +919,8 @@ declare namespace bundleManager { * @syscap SystemCapability.BundleManager.BundleFramework.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum LaunchType { /** @@ -839,7 +942,8 @@ declare namespace bundleManager { * @syscap SystemCapability.BundleManager.BundleFramework.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SINGLETON = 0, @@ -862,7 +966,8 @@ declare namespace bundleManager { * @syscap SystemCapability.BundleManager.BundleFramework.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MULTITON = 1, @@ -877,7 +982,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SPECIFIED = 2 } @@ -932,7 +1038,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum DisplayOrientation { /** @@ -946,7 +1053,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNSPECIFIED, @@ -961,7 +1069,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LANDSCAPE, @@ -976,7 +1085,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PORTRAIT, @@ -991,7 +1101,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLLOW_RECENT, @@ -1006,7 +1117,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LANDSCAPE_INVERTED, @@ -1021,7 +1133,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PORTRAIT_INVERTED, @@ -1036,7 +1149,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION, @@ -1051,7 +1165,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION_LANDSCAPE, @@ -1066,7 +1181,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION_PORTRAIT, @@ -1081,7 +1197,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION_RESTRICTED, @@ -1096,7 +1213,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION_LANDSCAPE_RESTRICTED, @@ -1111,7 +1229,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION_PORTRAIT_RESTRICTED, @@ -1126,7 +1245,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LOCKED, @@ -1135,7 +1255,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_ROTATION_UNSPECIFIED, @@ -1144,7 +1265,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLLOW_DESKTOP } @@ -1162,7 +1284,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ModuleType { /** @@ -1176,7 +1299,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTRY = 1, /** @@ -1190,7 +1314,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FEATURE = 2, /** @@ -1204,7 +1329,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SHARED = 3 } @@ -1222,7 +1348,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum BundleType { /** @@ -1236,7 +1363,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ APP = 0, /** @@ -1248,7 +1376,8 @@ declare namespace bundleManager { * Indicates atomic service * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ATOMIC_SERVICE = 1 } @@ -1266,7 +1395,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum CompatiblePolicy { /** @@ -1280,7 +1410,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ BACKWARD_COMPATIBILITY = 1 } @@ -1291,7 +1422,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ProfileType { /** @@ -1299,7 +1431,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENT_PROFILE = 1 } @@ -1310,7 +1443,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum AppDistributionType { /** @@ -1318,7 +1452,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_GALLERY = 1, @@ -1327,7 +1462,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTERPRISE = 2, @@ -1337,7 +1473,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTERPRISE_NORMAL = 3, @@ -1347,7 +1484,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTERPRISE_MDM = 4, @@ -1356,7 +1494,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OS_INTEGRATION = 5, @@ -1365,7 +1504,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CROWDTESTING = 6, @@ -1374,7 +1514,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 7 } @@ -1384,28 +1525,32 @@ declare namespace bundleManager { * * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum MultiAppModeType { /** * Indicates multi app mode with type of unspecified * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UNSPECIFIED = 0, /** * Indicates multi app mode with type of multiInstance * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MULTI_INSTANCE = 1, /** * Indicates multi app mode with type of appClone * * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ APP_CLONE = 2, } @@ -1416,7 +1561,8 @@ declare namespace bundleManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ApplicationInfoFlag { /** @@ -1424,7 +1570,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_INSTALLED = 0x00000001, /** @@ -1432,7 +1579,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_OTHER_INSTALLED = 0x00000010, /** @@ -1440,7 +1588,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_PREINSTALLED_APP = 0x00000020, /** @@ -1448,7 +1597,8 @@ declare namespace bundleManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_PREINSTALLED_APP_UPDATE = 0x00000040, } @@ -1456,7 +1606,7 @@ declare namespace bundleManager { /** * Obtains own bundleInfo. * - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @returns { Promise } The result of getting the bundle info. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core @@ -1465,19 +1615,20 @@ declare namespace bundleManager { /** * Obtains own bundleInfo. * - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @returns { Promise } The result of getting the bundle info. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfoForSelf(bundleFlags: number): Promise; /** * Obtains own bundleInfo. * - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { AsyncCallback } callback - The callback of getting bundle info result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core @@ -1486,19 +1637,20 @@ declare namespace bundleManager { /** * Obtains own bundleInfo. * - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { AsyncCallback } callback - The callback of getting bundle info result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfoForSelf(bundleFlags: number, callback: AsyncCallback): void; /** * Obtains own bundleInfo. * - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @returns { BundleInfo } The result of getting the bundle info. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core @@ -1507,12 +1659,13 @@ declare namespace bundleManager { /** * Obtains own bundleInfo. * - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @returns { BundleInfo } The result of getting the bundle info. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfoForSelfSync(bundleFlags: number): BundleInfo; @@ -1521,14 +1674,15 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { AsyncCallback } callback - The callback of getting bundle info result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback): void; @@ -1537,7 +1691,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @param { AsyncCallback } callback - The callback of getting bundle info result. * @throws { BusinessError } 201 - Permission denied. @@ -1546,7 +1700,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback): void; @@ -1556,7 +1711,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @returns { Promise } The result of getting the bundle info. * @throws { BusinessError } 201 - Permission denied. @@ -1565,7 +1720,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfo(bundleName: string, bundleFlags: number, userId?: number): Promise; @@ -1574,7 +1730,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. + * @param { number } appFlags {@link ApplicationFlag} - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. * @param { AsyncCallback } callback - The callback of getting application info result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -1583,7 +1739,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getApplicationInfo(bundleName: string, appFlags: number, callback: AsyncCallback): void; @@ -1592,7 +1749,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. + * @param { number } appFlags {@link ApplicationFlag} - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @param { AsyncCallback } callback - The callback of getting application info result. * @throws { BusinessError } 201 - Permission denied. @@ -1603,7 +1760,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getApplicationInfo(bundleName: string, appFlags: number, userId: number, callback: AsyncCallback): void; @@ -1613,7 +1771,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. + * @param { number } appFlags {@link ApplicationFlag} - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @returns { Promise } The result of getting the application info. * @throws { BusinessError } 201 - Permission denied. @@ -1624,7 +1782,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getApplicationInfo(bundleName: string, appFlags: number, userId?: number): Promise; @@ -1632,14 +1791,15 @@ declare namespace bundleManager { * Obtains BundleInfo of all bundles available in the system. * * @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo that will be returned. * @param { AsyncCallback> } callback - The callback of getting a list of BundleInfo objects. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllBundleInfo(bundleFlags: number, callback: AsyncCallback>): void; @@ -1647,7 +1807,7 @@ declare namespace bundleManager { * Obtains BundleInfo of all bundles available in the system. * * @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo that will be returned. * @param { number } userId - Indicates the user id. * @param { AsyncCallback> } callback - The callback of getting a list of BundleInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1656,7 +1816,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllBundleInfo(bundleFlags: number, userId: number, callback: AsyncCallback>): void; @@ -1664,7 +1825,7 @@ declare namespace bundleManager { * Obtains BundleInfo of all bundles available in the system. * * @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo that will be returned. * @param { number } userId - Indicates the user id. * @returns { Promise> } Returns a list of BundleInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1673,7 +1834,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllBundleInfo(bundleFlags: number, userId?: number): Promise>; @@ -1681,14 +1843,15 @@ declare namespace bundleManager { * Obtains information about all installed applications of a specified user. * * @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST - * @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. + * @param { number } appFlags {@link ApplicationFlag} - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. * @param { AsyncCallback> } callback - The callback of getting a list of ApplicationInfo objects. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllApplicationInfo(appFlags: number, callback: AsyncCallback>): void; @@ -1696,7 +1859,7 @@ declare namespace bundleManager { * Obtains information about all installed applications of a specified user. * * @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST - * @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. + * @param { number } appFlags {@link ApplicationFlag} - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @param { AsyncCallback> } callback - The callback of getting a list of ApplicationInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1705,7 +1868,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllApplicationInfo(appFlags: number, userId: number, callback: AsyncCallback>): void; @@ -1714,7 +1878,7 @@ declare namespace bundleManager { * Obtains information about all installed applications of a specified user. * * @permission ohos.permission.GET_INSTALLED_BUNDLE_LIST - * @param { number } appFlags - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. + * @param { number } appFlags {@link ApplicationFlag} - Indicates the flag used to specify information contained in the ApplicationInfo objects that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @returns { Promise> } Returns a list of ApplicationInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1723,7 +1887,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllApplicationInfo(appFlags: number, userId?: number): Promise>; @@ -1732,7 +1897,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. - * @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. + * @param { number } abilityFlags {@link AbilityFlag} - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. * @param { AsyncCallback> } callback - The callback of querying ability info result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -1744,7 +1909,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryAbilityInfo(want: Want, abilityFlags: number, callback: AsyncCallback>): void; @@ -1753,7 +1919,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. - * @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. + * @param { number } abilityFlags {@link AbilityFlag} - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. * @param { number } userId - userId Indicates the user ID. * @param { AsyncCallback> } callback - The callback of querying ability info result. * @throws { BusinessError } 201 - Permission denied. @@ -1767,7 +1933,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryAbilityInfo(want: Want, abilityFlags: number, userId: number, callback: AsyncCallback>): void; @@ -1777,7 +1944,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. - * @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. + * @param { number } abilityFlags {@link AbilityFlag} - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. * @param { number } userId - userId Indicates the user ID. * @returns { Promise> } Returns a list of AbilityInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1791,7 +1958,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryAbilityInfo(want: Want, abilityFlags: number, userId?: number): Promise>; @@ -1800,7 +1968,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Array } wants - Indicates the Want Array containing the application bundle name to be queried. - * @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. + * @param { number } abilityFlags {@link AbilityFlag} - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. * @param { number } [userId] - userId Indicates the user ID. * @returns { Promise> } Returns a list of AbilityInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1814,7 +1982,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryAbilityInfo(wants: Array, abilityFlags: number, userId?: number): Promise>; @@ -1823,7 +1992,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. - * @param { number } abilityFlags - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. + * @param { number } abilityFlags {@link AbilityFlag} - Indicates the flag used to specify information contained in the AbilityInfo objects that will be returned. * @param { number } userId - userId Indicates the user ID. * @returns { Array } Returns a list of AbilityInfo objects. * @throws { BusinessError } 201 - Permission denied. @@ -1837,7 +2006,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryAbilityInfoSync(want: Want, abilityFlags: number, userId?: number): Array; @@ -1847,7 +2017,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. * @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType. - * @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the + * @param { number } extensionAbilityFlags {@link ExtensionAbilityFlag} - Indicates the flag used to specify information contained in the * ExtensionAbilityInfo objects that will be returned. * @param { AsyncCallback> } callback - The callback of querying extension ability info result. * @throws { BusinessError } 201 - Permission denied. @@ -1859,7 +2029,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryExtensionAbilityInfo(want: Want, extensionAbilityType: ExtensionAbilityType, extensionAbilityFlags: number, callback: AsyncCallback>): void; @@ -1870,7 +2041,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. * @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType. - * @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the + * @param { number } extensionAbilityFlags {@link ExtensionAbilityFlag} - Indicates the flag used to specify information contained in the * ExtensionAbilityInfo objects that will be returned. * @param { number } userId - Indicates the user ID. * @param { AsyncCallback> } callback - The callback of querying extension ability info result. @@ -1884,7 +2055,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryExtensionAbilityInfo(want: Want, extensionAbilityType: ExtensionAbilityType, extensionAbilityFlags: number, userId: number, callback: AsyncCallback>): void; @@ -1895,7 +2067,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. * @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType. - * @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the + * @param { number } extensionAbilityFlags {@link ExtensionAbilityFlag} - Indicates the flag used to specify information contained in the * ExtensionAbilityInfo objects that will be returned. * @param { number } userId - Indicates the user ID. * @returns { Promise> } Returns a list of ExtensionAbilityInfo objects. @@ -1909,7 +2081,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryExtensionAbilityInfo(want: Want, extensionAbilityType: ExtensionAbilityType, extensionAbilityFlags: number, userId?: number): Promise>; @@ -1920,7 +2093,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. * @param { ExtensionAbilityType } extensionAbilityType - Indicates ExtensionAbilityType. - * @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the + * @param { number } extensionAbilityFlags {@link ExtensionAbilityFlag} - Indicates the flag used to specify information contained in the * ExtensionAbilityInfo objects that will be returned. * @param { number } userId - Indicates the user ID. * @returns { Array } Returns a list of ExtensionAbilityInfo objects. @@ -1934,7 +2107,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryExtensionAbilityInfoSync(want: Want, extensionAbilityType: ExtensionAbilityType, extensionAbilityFlags: number, userId?: number): Array; @@ -1945,7 +2119,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { Want } want - Indicates the Want containing the application bundle name to be queried. * @param { string } extensionAbilityType - Indicates extensionAbilityType. - * @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the + * @param { number } extensionAbilityFlags {@link ExtensionAbilityFlag} - Indicates the flag used to specify information contained in the * ExtensionAbilityInfo objects that will be returned. * @param { number } userId - Indicates the user ID. * @returns { Array } Returns a list of ExtensionAbilityInfo objects. @@ -1959,7 +2133,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryExtensionAbilityInfoSync(want: Want, extensionAbilityType: string, extensionAbilityFlags: number, userId?: number): Array; @@ -1969,7 +2144,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } extensionAbilityType - Indicates ExtensionAbilityType. - * @param { number } extensionAbilityFlags - Indicates the flag used to specify information contained in the + * @param { number } extensionAbilityFlags {@link ExtensionAbilityFlag} - Indicates the flag used to specify information contained in the * ExtensionAbilityInfo objects that will be returned. * @param { number } userId - Indicates the user ID. * @returns { Array } Returns a list of ExtensionAbilityInfo objects. @@ -1981,7 +2156,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified userId is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function queryExtensionAbilityInfoSync(extensionAbilityType: string, extensionAbilityFlags: number, userId?: number): Array; @@ -1996,7 +2172,8 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700021 - The uid is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleNameByUid(uid: number, callback: AsyncCallback): void; @@ -2010,7 +2187,8 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700021 - The uid is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleNameByUid(uid: number): Promise; @@ -2024,7 +2202,8 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700021 - The uid is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleNameByUidSync(uid: number): string; @@ -2034,7 +2213,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @param { string } hapFilePath - Indicates the path storing the HAP. * The path should be the relative path to the data directory of the current application. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object to be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo object to be returned. * @param { AsyncCallback } callback - The callback of getting bundle archive info result. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -2052,7 +2231,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @param { string } hapFilePath - Indicates the path storing the HAP. * The path should be the relative path to the data directory of the current application. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object to be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo object to be returned. * @returns { Promise } Returns the BundleInfo object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -2070,7 +2249,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @param { string } hapFilePath - Indicates the path storing the HAP. * The path should be the relative path to the data directory of the current application. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object to be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo object to be returned. * @returns { BundleInfo } Returns the BundleInfo object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. @@ -2176,7 +2355,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function setApplicationEnabled(bundleName: string, appIndex: number, isEnabled: boolean): Promise; @@ -2193,7 +2373,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setApplicationEnabled(bundleName: string, isEnabled: boolean, callback: AsyncCallback): void; @@ -2210,7 +2391,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setApplicationEnabled(bundleName: string, isEnabled: boolean): Promise; @@ -2226,7 +2408,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setApplicationEnabledSync(bundleName: string, isEnabled: boolean): void; @@ -2246,7 +2429,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function setAbilityEnabled(info: AbilityInfo, appIndex: number, isEnabled: boolean): Promise; @@ -2264,7 +2448,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700003 - The specified abilityInfo is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setAbilityEnabled(info: AbilityInfo, isEnabled: boolean, callback: AsyncCallback): void; @@ -2282,7 +2467,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700003 - The specified abilityInfo is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setAbilityEnabled(info: AbilityInfo, isEnabled: boolean): Promise; @@ -2299,7 +2485,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700003 - The specified abilityInfo is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setAbilityEnabledSync(info: AbilityInfo, isEnabled: boolean): void; @@ -2315,7 +2502,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function isApplicationEnabled(bundleName: string, appIndex: number): Promise; @@ -2329,7 +2517,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isApplicationEnabled(bundleName: string, callback: AsyncCallback): void; @@ -2343,7 +2532,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isApplicationEnabled(bundleName: string): Promise; @@ -2357,7 +2547,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function isApplicationEnabledSync(bundleName: string): boolean; @@ -2374,7 +2565,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function isAbilityEnabled(info: AbilityInfo, appIndex: number): Promise; @@ -2389,7 +2581,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700003 - The specified abilityName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isAbilityEnabled(info: AbilityInfo, callback: AsyncCallback): void; @@ -2404,7 +2597,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700003 - The specified abilityName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isAbilityEnabled(info: AbilityInfo): Promise; @@ -2419,7 +2613,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700003 - The specified abilityName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function isAbilityEnabledSync(info: AbilityInfo): boolean; @@ -2440,7 +2635,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLaunchWantForBundle(bundleName: string, userId: number, callback: AsyncCallback): void; @@ -2459,7 +2655,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLaunchWantForBundle(bundleName: string, callback: AsyncCallback): void; @@ -2480,7 +2677,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLaunchWantForBundle(bundleName: string, userId?: number): Promise; @@ -2501,7 +2699,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLaunchWantForBundleSync(bundleName: string, userId?: number): Want; @@ -2789,7 +2988,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAbilityLabel(bundleName: string, moduleName: string, abilityName: string, callback: AsyncCallback): void; @@ -2812,7 +3012,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAbilityLabel(bundleName: string, moduleName: string, abilityName: string): Promise; @@ -2835,7 +3036,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700029 - The specified ability is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAbilityLabelSync(bundleName: string, moduleName: string, abilityName: string): string; @@ -2855,7 +3057,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getApplicationInfoSync(bundleName: string, applicationFlags: number, userId: number): ApplicationInfo; @@ -2873,7 +3076,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getApplicationInfoSync(bundleName: string, applicationFlags: number): ApplicationInfo; @@ -2882,7 +3086,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo object that will be returned. * @param { number } userId - Indicates the user ID or do not pass user ID. * @returns { BundleInfo } - Returns the BundleInfo object. * @throws { BusinessError } 201 - Permission denied. @@ -2891,7 +3095,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfoSync(bundleName: string, bundleFlags: number, userId: number): BundleInfo; @@ -2900,14 +3105,15 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo object that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo object that will be returned. * @returns { BundleInfo } - Returns the BundleInfo object. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInfoSync(bundleName: string, bundleFlags: number): BundleInfo; @@ -3059,7 +3265,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSpecifiedDistributionType(bundleName: string): string; @@ -3137,7 +3344,7 @@ declare namespace bundleManager { * @systemapi * @since 12 */ - function getExtResource(bundleName: string): Promise>; + function getExtResource(bundleName: string): Promise>; /** * Enable dynamic icon. @@ -3154,7 +3361,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700304 - Failed to enable the dynamic icon. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function enableDynamicIcon(bundleName: string, moduleName: string): Promise; @@ -3188,7 +3396,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700306 - Failed to obtain the dynamic icon. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDynamicIcon(bundleName: string): Promise; @@ -3373,7 +3582,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @param { number } appDistributionType - Indicates the distribution type of the application, and if not passed in, it gets all the developerId. - * @returns { Array } Returns a list of developerId. + * @returns { Array } Returns a list of developerId. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. @@ -3381,7 +3590,7 @@ declare namespace bundleManager { * @systemapi * @since 12 */ - function getDeveloperIds(appDistributionType?: number): Array; + function getDeveloperIds(appDistributionType?: number): Array; /** * Switch uninstall state of a specified application. @@ -3407,7 +3616,6 @@ declare namespace bundleManager { * @param { number } uid - Indicates the UID of an application. * @returns { SignatureInfo } The result of getting the signature info. * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700021 - The uid is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @since 18 @@ -3420,7 +3628,7 @@ declare namespace bundleManager { * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @param { string } bundleName - Indicates the application bundle name to be queried. * @param { number } appIndex - Indicates the index of clone app. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { number } [userId] - Indicates the user ID, If the user id is not specified, the current user id is used by default. * @returns { Promise } Returns A BundleInfo Of MultiApp Mode. * @throws { BusinessError } 201 - Permission denied. @@ -3432,7 +3640,8 @@ declare namespace bundleManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAppCloneBundleInfo(bundleName: string, appIndex: number, bundleFlags: number, userId?: number): Promise; @@ -3441,7 +3650,7 @@ declare namespace bundleManager { * * @permission ohos.permission.GET_BUNDLE_INFO_PRIVILEGED * @param { string } bundleName - Indicates the application bundle name to be queried. - * @param { number } bundleFlags - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. + * @param { number } bundleFlags {@link BundleFlag} - Indicates the flag used to specify information contained in the BundleInfo objects that will be returned. * @param { number } [userId] - Indicates the user ID, If the user id is not specified, the current user id is used by default. * @returns { Promise> } Returns BundleInfo Arrays Of MultiApp Mode. * @throws { BusinessError } 201 - Permission denied. @@ -3466,7 +3675,8 @@ declare namespace bundleManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700021 - The uid is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAppCloneIdentity(uid: number): Promise; @@ -3479,12 +3689,11 @@ declare namespace bundleManager { * @returns { Promise> } Returns PluginBundleInfo Arrays. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since 19 */ function getAllPluginInfo(hostBundleName: string, userId?: number): Promise>; @@ -3497,7 +3706,6 @@ declare namespace bundleManager { * @returns { Promise } The result of migrating data. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. - * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 17700080 - The source paths are invalid. * @throws { BusinessError } 17700081 - The destination path is invalid. * @throws { BusinessError } 17700082 - User authentication failed. @@ -3524,7 +3732,8 @@ declare namespace bundleManager { * @typedef { _ApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ApplicationInfo = _ApplicationInfo; @@ -3541,7 +3750,8 @@ declare namespace bundleManager { * @typedef { _ModuleMetadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ModuleMetadata = _ModuleMetadata; @@ -3558,7 +3768,8 @@ declare namespace bundleManager { * @typedef { _Metadata } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type Metadata = _Metadata; @@ -3579,6 +3790,17 @@ declare namespace bundleManager { */ export type BundleInfo = _BundleInfo.BundleInfo; + /** + * Obtains configuration information about a bundle. + * + * @typedef { _BundleInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type BundleInfo = _BundleInfo; + /** * The scene which is used. * @@ -3596,6 +3818,17 @@ declare namespace bundleManager { */ export type UsedScene = _BundleInfo.UsedScene; + /** + * The scene which is used. + * + * @typedef { _UsedScene } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type UsedScene = _UsedScene; + /** * Indicates the required permissions details defined in file config.json. * @@ -3613,6 +3846,17 @@ declare namespace bundleManager { */ export type ReqPermissionDetail = _BundleInfo.ReqPermissionDetail; + /** + * Indicates the required permissions details defined in file config.json. + * + * @typedef { _ReqPermissionDetail } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type ReqPermissionDetail = _ReqPermissionDetail; + /** * Indicates the SignatureInfo. * @@ -3630,6 +3874,17 @@ declare namespace bundleManager { */ export type SignatureInfo = _BundleInfo.SignatureInfo; + /** + * Indicates the SignatureInfo. + * + * @typedef { _SignatureInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type SignatureInfo = _SignatureInfo; + /** * AppCloneIdentity Contain BundleName and appIndex. * @@ -3639,6 +3894,16 @@ declare namespace bundleManager { */ export type AppCloneIdentity = _BundleInfo.AppCloneIdentity; + /** + * AppCloneIdentity Contain BundleName and appIndex. + * + * @typedef { _AppCloneIdentity } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @since 20 + * @arkts 1.2 + */ + export type AppCloneIdentity = _AppCloneIdentity; + /** * Obtains configuration information about a module. * @@ -3656,6 +3921,17 @@ declare namespace bundleManager { */ export type HapModuleInfo = _HapModuleInfo.HapModuleInfo; + /** + * Obtains configuration information about a module. + * + * @typedef { _HapModuleInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type HapModuleInfo = _HapModuleInfo; + /** * Obtains preload information about a module. * @@ -3673,6 +3949,17 @@ declare namespace bundleManager { */ export type PreloadItem = _HapModuleInfo.PreloadItem; + /** + * Obtains preload information about a module. + * + * @typedef { _PreloadItem } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PreloadItem = _PreloadItem; + /** * Obtains dependency information about a module. * @@ -3690,6 +3977,17 @@ declare namespace bundleManager { */ export type Dependency = _HapModuleInfo.Dependency; + /** + * Obtains dependency information about a module. + * + * @typedef { _Dependency } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type Dependency = _Dependency; + /** * Obtains the router item about a module. * @@ -3700,6 +3998,17 @@ declare namespace bundleManager { */ export type RouterItem = _HapModuleInfo.RouterItem; + /** + * Obtains the router item about a module. + * + * @typedef { _RouterItem} + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type RouterItem = _RouterItem; + /** * Obtains the data item within router item. * @@ -3710,6 +4019,17 @@ declare namespace bundleManager { */ export type DataItem = _HapModuleInfo.DataItem; + /** + * Obtains the data item within router item. + * + * @typedef { _DataItem } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type DataItem = _DataItem; + /** * Obtains configuration information about an ability. * @@ -3727,6 +4047,17 @@ declare namespace bundleManager { */ export type AbilityInfo = _AbilityInfo.AbilityInfo; + /** + * Obtains configuration information about an ability. + * + * @typedef { _AbilityInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type AbilityInfo = _AbilityInfo; + /** * Contains basic Ability information. Indicates the window size.. * @@ -3744,6 +4075,17 @@ declare namespace bundleManager { */ export type WindowSize = _AbilityInfo.WindowSize; + /** + * Contains basic Ability information. Indicates the window size.. + * + * @typedef { _WindowSize } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type WindowSize = _WindowSize; + /** * Obtains extension information about a bundle. * @@ -3761,6 +4103,17 @@ declare namespace bundleManager { */ export type ExtensionAbilityInfo = _ExtensionAbilityInfo.ExtensionAbilityInfo; + /** + * Obtains extension information about a bundle. + * + * @typedef { _ExtensionAbilityInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type ExtensionAbilityInfo = _ExtensionAbilityInfo; + /** * Indicates the defined permission details in file config.json. * @@ -3784,7 +4137,8 @@ declare namespace bundleManager { * @typedef { _ElementName } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ElementName = _ElementName; @@ -3838,6 +4192,17 @@ declare namespace bundleManager { */ export type Skill = _Skill.Skill; + /** + * Obtains configuration information about an skill + * + * @typedef { _Skill } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type Skill = _Skill; + /** * Obtains configuration information about an skillUri * @@ -3848,13 +4213,25 @@ declare namespace bundleManager { */ export type SkillUrl = _Skill.SkillUri; + /** + * Obtains configuration information about an skillUri + * + * @typedef { _SkillUri } + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type SkillUrl = _SkillUri; + /** * Indicates the information of preinstalled application. * * @typedef { _PreinstalledApplicationInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type PreinstalledApplicationInfo = _PreinstalledApplicationInfo; @@ -3864,7 +4241,7 @@ declare namespace bundleManager { * @typedef { _PluginBundleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since 19 */ export type PluginBundleInfo = _PluginBundleInfo; @@ -3874,7 +4251,7 @@ declare namespace bundleManager { * @typedef { _PluginModuleInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since 19 */ export type PluginModuleInfo = _PluginModuleInfo; } diff --git a/api/@ohos.bundle.bundleMonitor.d.ts b/api/@ohos.bundle.bundleMonitor.d.ts index 42ea5d3b421854e31d50097f10382f94df0429a8..889a0cb437e35ca191f01662fbddc44c0d0b4922 100644 --- a/api/@ohos.bundle.bundleMonitor.d.ts +++ b/api/@ohos.bundle.bundleMonitor.d.ts @@ -26,7 +26,8 @@ import { Callback } from './@ohos.base'; * @namespace bundleMonitor * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace bundleMonitor { /** @@ -35,7 +36,8 @@ declare namespace bundleMonitor { * @typedef BundleChangedInfo * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface BundleChangedInfo { /** @@ -45,7 +47,8 @@ declare namespace bundleMonitor { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly bundleName: string; /** @@ -55,7 +58,8 @@ declare namespace bundleMonitor { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly userId: number; /** @@ -65,7 +69,8 @@ declare namespace bundleMonitor { * @readonly * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly appIndex: number; } @@ -76,7 +81,8 @@ declare namespace bundleMonitor { * @typedef { 'add' | 'update' | 'remove' } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type BundleChangedEvent = 'add' | 'update' | 'remove'; @@ -91,7 +97,8 @@ declare namespace bundleMonitor { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: BundleChangedEvent, callback: Callback): void; @@ -106,7 +113,8 @@ declare namespace bundleMonitor { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: BundleChangedEvent, callback?: Callback): void; } diff --git a/api/@ohos.bundle.bundleResourceManager.d.ts b/api/@ohos.bundle.bundleResourceManager.d.ts index ef2deaf321dce5a94c1cecbd90482f9c95239050..f9fb981015d92469186fa0830676995c6cf7102f 100644 --- a/api/@ohos.bundle.bundleResourceManager.d.ts +++ b/api/@ohos.bundle.bundleResourceManager.d.ts @@ -18,9 +18,16 @@ * @kit AbilityKit */ +/*** if arkts 1.1 */ import type { AsyncCallback } from './@ohos.base'; import type { BundleResourceInfo as _BundleResourceInfo } from './bundleManager/BundleResourceInfo'; import type { LauncherAbilityResourceInfo as _LauncherAbilityResourceInfo } from './bundleManager/LauncherAbilityResourceInfo'; +/*** endif */ +/*** if arkts 1.2 */ +import { AsyncCallback } from './@ohos.base'; +import { BundleResourceInfo as _BundleResourceInfo } from './bundleManager/BundleResourceInfo'; +import { LauncherAbilityResourceInfo as _LauncherAbilityResourceInfo } from './bundleManager/LauncherAbilityResourceInfo'; +/*** endif */ /** * This module is used to obtain bundle resource information of various applications installed on the current device. @@ -28,7 +35,8 @@ import type { LauncherAbilityResourceInfo as _LauncherAbilityResourceInfo } from * @namespace bundleResourceManager * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace bundleResourceManager { /** @@ -37,7 +45,8 @@ declare namespace bundleResourceManager { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ResourceFlag { /** @@ -45,7 +54,8 @@ declare namespace bundleResourceManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_RESOURCE_INFO_ALL = 0x00000001, @@ -54,7 +64,8 @@ declare namespace bundleResourceManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_RESOURCE_INFO_WITH_LABEL = 0x00000002, @@ -63,7 +74,8 @@ declare namespace bundleResourceManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_RESOURCE_INFO_WITH_ICON = 0x00000004, @@ -73,7 +85,8 @@ declare namespace bundleResourceManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_RESOURCE_INFO_WITH_SORTED_BY_LABEL = 0x00000008, @@ -82,7 +95,8 @@ declare namespace bundleResourceManager { * * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_RESOURCE_INFO_WITH_DRAWABLE_DESCRIPTOR = 0x00000010 } @@ -100,7 +114,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleResourceInfo(bundleName: string, resourceFlags?: number): BundleResourceInfo; @@ -119,7 +134,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range or not found. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleResourceInfo(bundleName: string, resourceFlags?: number, appIndex?: number): BundleResourceInfo; @@ -136,7 +152,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 17700001 - The specified bundleName is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLauncherAbilityResourceInfo(bundleName: string, resourceFlags?: number): Array; @@ -156,7 +173,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 17700061 - AppIndex not in valid range or not found. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLauncherAbilityResourceInfo(bundleName: string, resourceFlags?: number, appIndex?: number): Array; @@ -171,7 +189,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllBundleResourceInfo(resourceFlags: number, callback: AsyncCallback>): void; @@ -186,7 +205,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllBundleResourceInfo(resourceFlags: number): Promise>; @@ -201,7 +221,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllLauncherAbilityResourceInfo(resourceFlags: number, callback: AsyncCallback>): void; @@ -216,7 +237,8 @@ declare namespace bundleResourceManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllLauncherAbilityResourceInfo(resourceFlags: number): Promise>; @@ -226,7 +248,8 @@ declare namespace bundleResourceManager { * @typedef { _BundleResourceInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type BundleResourceInfo = _BundleResourceInfo; @@ -236,7 +259,8 @@ declare namespace bundleResourceManager { * @typedef { _LauncherAbilityResourceInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Resource * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type LauncherAbilityResourceInfo = _LauncherAbilityResourceInfo; } diff --git a/api/@ohos.bundle.defaultAppManager.d.ts b/api/@ohos.bundle.defaultAppManager.d.ts index 7ee73e02f674e32312dc319b69c6e9256a749071..358a1d920b190107ebb907fd24a5377470b9d87c 100644 --- a/api/@ohos.bundle.defaultAppManager.d.ts +++ b/api/@ohos.bundle.defaultAppManager.d.ts @@ -27,7 +27,8 @@ import { ElementName } from './bundleManager/ElementName'; * * @namespace defaultAppManager * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace defaultAppManager { /** @@ -35,70 +36,80 @@ declare namespace defaultAppManager { * * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ApplicationType { /** * Default browser identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ BROWSER = 'Web Browser', /** * Default image identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 'Image Gallery', /** * Default audio identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO = 'Audio Player', /** * Default video identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO = 'Video Player', /** * Default PDF identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PDF = 'PDF Viewer', /** * Default word identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ WORD = 'Word Viewer', /** * Default excel identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ EXCEL = 'Excel Viewer', /** * Default PPT identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PPT = 'PPT Viewer', /** * Default email identifier. * * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EMAIL = 'Email' } @@ -111,7 +122,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultApplication(type: string, callback: AsyncCallback): void; @@ -123,7 +135,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultApplication(type: string): Promise; @@ -135,7 +148,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultApplicationSync(type: string): boolean; @@ -155,7 +169,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultApplication(type: string, userId: number, callback: AsyncCallback): void; @@ -173,7 +188,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultApplication(type: string, callback: AsyncCallback): void; @@ -193,7 +209,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultApplication(type: string, userId?: number): Promise; @@ -213,7 +230,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultApplicationSync(type: string, userId?: number): BundleInfo; @@ -234,7 +252,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700028 - The specified ability does not match the type. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDefaultApplication(type: string, elementName: ElementName, userId: number, callback: AsyncCallback): void; @@ -254,7 +273,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700028 - The specified ability does not match the type. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDefaultApplication(type: string, elementName: ElementName, callback: AsyncCallback): void; @@ -275,7 +295,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700028 - The specified ability does not match the type. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise; @@ -295,7 +316,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700028 - The specified ability does not match the type. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDefaultApplicationSync(type: string, elementName: ElementName, userId?: number): void; @@ -314,7 +336,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function resetDefaultApplication(type: string, userId: number, callback: AsyncCallback): void; @@ -331,7 +354,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function resetDefaultApplication(type: string, callback: AsyncCallback): void; @@ -350,7 +374,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function resetDefaultApplication(type: string, userId?: number): Promise; @@ -368,7 +393,8 @@ declare namespace defaultAppManager { * @throws { BusinessError } 17700025 - The specified type is invalid. * @syscap SystemCapability.BundleManager.BundleFramework.DefaultApp * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function resetDefaultApplicationSync(type: string, userId?: number): void; } diff --git a/api/@ohos.bundle.distributedBundleManager.d.ts b/api/@ohos.bundle.distributedBundleManager.d.ts index bc13c960d8325e75f9821afb61046652ef04f563..a85231f931b605c07ccf6ffea065375f785df553 100644 --- a/api/@ohos.bundle.distributedBundleManager.d.ts +++ b/api/@ohos.bundle.distributedBundleManager.d.ts @@ -28,7 +28,8 @@ import { RemoteAbilityInfo as _RemoteAbilityInfo } from './bundleManager/RemoteA * @namespace distributedBundleManager * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace distributedBundleManager { /** @@ -47,7 +48,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback): void; @@ -67,7 +69,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementName: ElementName): Promise; @@ -87,7 +90,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementNames: Array, callback: AsyncCallback>): void; @@ -108,7 +112,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementNames: Array): Promise>; @@ -129,7 +134,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementName: ElementName, locale: string, callback: AsyncCallback): void; @@ -151,7 +157,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementName: ElementName, locale: string): Promise; @@ -172,7 +179,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementNames: Array, locale: string, callback: AsyncCallback>): void; @@ -194,7 +202,8 @@ declare namespace distributedBundleManager { * @throws { BusinessError } 17700027 - The distributed service is not running. * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRemoteAbilityInfo(elementNames: Array, locale: string): Promise>; @@ -204,7 +213,8 @@ declare namespace distributedBundleManager { * @typedef { _RemoteAbilityInfo } * @syscap SystemCapability.BundleManager.DistributedBundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type RemoteAbilityInfo = _RemoteAbilityInfo; } diff --git a/api/@ohos.bundle.freeInstall.d.ts b/api/@ohos.bundle.freeInstall.d.ts index e445c411bf513945638bad1495b067c24e550d43..12a62c8872070a7318d1f05e10fece02811e317d 100644 --- a/api/@ohos.bundle.freeInstall.d.ts +++ b/api/@ohos.bundle.freeInstall.d.ts @@ -20,7 +20,15 @@ import { AsyncCallback } from './@ohos.base'; import { DispatchInfo as _DispatchInfo } from './bundleManager/DispatchInfo'; +/*** if arkts 1.1 */ import * as _PackInfo from './bundleManager/BundlePackInfo'; +/*** endif */ +/*** if arkts 1.2 */ +import { BundlePackInfo as _BundlePackInfo, PackageConfig as _PackageConfig, PackageSummary as _PackageSummary, + BundleConfigInfo as _BundleConfigInfo, ExtensionAbility as _ExtensionAbility, ModuleConfigInfo as _ModuleConfigInfo, + ModuleDistroInfo as _ModuleDistroInfo, ModuleAbilityInfo as _ModuleAbilityInfo, AbilityFormInfo as _AbilityFormInfo, + Version as _Version, ApiVersion as _ApiVersion } from './bundleManager/BundlePackInfo'; +/*** endif */ /** * Free install bundle manager. @@ -28,7 +36,8 @@ import * as _PackInfo from './bundleManager/BundlePackInfo'; * @namespace freeInstall * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace freeInstall { /** @@ -37,7 +46,8 @@ declare namespace freeInstall { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum UpgradeFlag { /** @@ -45,7 +55,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NOT_UPGRADE = 0, /** @@ -53,7 +64,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SINGLE_UPGRADE = 1, /** @@ -61,7 +73,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ RELATION_UPGRADE = 2 } @@ -72,7 +85,8 @@ declare namespace freeInstall { * @enum { number } * @syscap SystemCapability.BundleManager.BundleFramework * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum BundlePackFlag { /** @@ -80,7 +94,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_PACK_INFO_ALL = 0x00000000, /** @@ -88,7 +103,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_PACKAGES = 0x00000001, /** @@ -96,7 +112,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_BUNDLE_SUMMARY = 0x00000002, /** @@ -104,7 +121,8 @@ declare namespace freeInstall { * * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ GET_MODULE_SUMMARY = 0x00000004 } @@ -125,7 +143,8 @@ declare namespace freeInstall { * @throws { BusinessError } 17700002 - The specified module name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setHapModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag, callback: AsyncCallback): void; @@ -146,7 +165,8 @@ declare namespace freeInstall { * @throws { BusinessError } 17700002 - The specified module name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setHapModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag): Promise; @@ -166,7 +186,8 @@ declare namespace freeInstall { * @throws { BusinessError } 17700002 - The specified module name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isHapModuleRemovable(bundleName: string, moduleName: string, callback: AsyncCallback): void; @@ -185,7 +206,8 @@ declare namespace freeInstall { * @throws { BusinessError } 17700002 - The specified module name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isHapModuleRemovable(bundleName: string, moduleName: string): Promise; @@ -203,7 +225,8 @@ declare namespace freeInstall { * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundlePackInfo(bundleName: string, bundlePackFlag: BundlePackFlag, callback: AsyncCallback): void; @@ -222,7 +245,8 @@ declare namespace freeInstall { * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundlePackInfo(bundleName: string, bundlePackFlag: BundlePackFlag): Promise; @@ -236,7 +260,8 @@ declare namespace freeInstall { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDispatchInfo(callback: AsyncCallback): void; @@ -250,7 +275,8 @@ declare namespace freeInstall { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDispatchInfo(): Promise; @@ -260,7 +286,8 @@ declare namespace freeInstall { * @typedef { _DispatchInfo } * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type DispatchInfo = _DispatchInfo; @@ -274,6 +301,17 @@ declare namespace freeInstall { */ export type BundlePackInfo = _PackInfo.BundlePackInfo; + /** + * The bundle pack info class. + * + * @typedef { _BundlePackInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type BundlePackInfo = _BundlePackInfo; + /** * The package info class. * @@ -284,6 +322,17 @@ declare namespace freeInstall { */ export type PackageConfig = _PackInfo.PackageConfig; + /** + * The package info class. + * + * @typedef { _PackageConfig } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type PackageConfig = _PackageConfig; + /** * The package summary class. * @@ -294,6 +343,17 @@ declare namespace freeInstall { */ export type PackageSummary = _PackInfo.PackageSummary; + /** + * The package summary class. + * + * @typedef { _PackageSummary } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type PackageSummary = _PackageSummary; + /** * The bundle summary class. * @@ -304,6 +364,17 @@ declare namespace freeInstall { */ export type BundleConfigInfo = _PackInfo.BundleConfigInfo; + /** + * The bundle summary class. + * + * @typedef { _BundleConfigInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type BundleConfigInfo = _BundleConfigInfo; + /** * The extension ability forms class. * @@ -314,6 +385,17 @@ declare namespace freeInstall { */ export type ExtensionAbility = _PackInfo.ExtensionAbility; + /** + * The extension ability forms class. + * + * @typedef { _ExtensionAbility } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type ExtensionAbility = _ExtensionAbility; + /** * The module summary of a bundle. * @@ -324,6 +406,17 @@ declare namespace freeInstall { */ export type ModuleConfigInfo = _PackInfo.ModuleConfigInfo; + /** + * The module summary of a bundle. + * + * @typedef { _ModuleConfigInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type ModuleConfigInfo = _ModuleConfigInfo; + /** * The bundle info summary class. * @@ -334,6 +427,17 @@ declare namespace freeInstall { */ export type ModuleDistroInfo = _PackInfo.ModuleDistroInfo; + /** + * The bundle info summary class. + * + * @typedef { _ModuleDistroInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type ModuleDistroInfo = _ModuleDistroInfo; + /** * The ability info of a module. * @@ -344,6 +448,17 @@ declare namespace freeInstall { */ export type ModuleAbilityInfo = _PackInfo.ModuleAbilityInfo; + /** + * The ability info of a module. + * + * @typedef { _ModuleAbilityInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type ModuleAbilityInfo = _ModuleAbilityInfo; + /** * The form info of an ability. * @@ -354,6 +469,17 @@ declare namespace freeInstall { */ export type AbilityFormInfo = _PackInfo.AbilityFormInfo; + /** + * The form info of an ability. + * + * @typedef { _AbilityFormInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type AbilityFormInfo = _AbilityFormInfo; + /** * The bundle version class. * @@ -364,6 +490,17 @@ declare namespace freeInstall { */ export type Version = _PackInfo.Version; + /** + * The bundle version class. + * + * @typedef { _Version } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type Version = _Version; + /** * The bundle Api version class. * @@ -373,6 +510,17 @@ declare namespace freeInstall { * @since 9 */ export type ApiVersion = _PackInfo.ApiVersion; + + /** + * The bundle Api version class. + * + * @typedef { _ApiVersion } + * @syscap SystemCapability.BundleManager.BundleFramework.FreeInstall + * @systemapi + * @since 20 + * @arkts 1.2 + */ + export type ApiVersion = _ApiVersion; } export default freeInstall; diff --git a/api/@ohos.bundle.installer.d.ts b/api/@ohos.bundle.installer.d.ts index b207ecf41b0ef38570a5a413fd70d192c79139a1..4a42437b13acb822228b1eb4a66f76204e40d8ff 100644 --- a/api/@ohos.bundle.installer.d.ts +++ b/api/@ohos.bundle.installer.d.ts @@ -26,7 +26,8 @@ import { AsyncCallback } from './@ohos.base'; * @namespace installer * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace installer { /** @@ -37,7 +38,8 @@ declare namespace installer { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Incorrect parameter types. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInstaller(callback: AsyncCallback): void; @@ -48,7 +50,8 @@ declare namespace installer { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInstaller(): Promise; @@ -59,7 +62,8 @@ declare namespace installer { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getBundleInstallerSync(): BundleInstaller; @@ -69,7 +73,8 @@ declare namespace installer { * @interface BundleInstaller * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface BundleInstaller { /** @@ -227,7 +232,7 @@ declare namespace installer { * @systemapi * @since 12 */ - /** + /** * Install HAPs for an application. * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. @@ -272,6 +277,52 @@ declare namespace installer { * @systemapi * @since 13 */ + /** + * Install HAPs for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * To install an internal beta application, you must have the permission ohos.permission.INSTALL_INTERNALTESTING_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { InstallParam } installParam - Indicates other parameters required for the installation. + * @param { AsyncCallback } callback - The callback of installing HAPs result. + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter hapFiles is needed for code signature; 4. The size of specifiedDistributionType is greater than 128; 5. The size of additionalInfo is greater than 3000. + * @throws { BusinessError } 17700004 - The specified user ID is not found. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. + * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same + *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 17 + */ /** * Install HAPs for an application. * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. @@ -317,7 +368,8 @@ declare namespace installer { * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ install(hapFilePaths: Array, installParam: InstallParam, callback: AsyncCallback): void; @@ -507,6 +559,50 @@ declare namespace installer { * @systemapi * @since 13 */ + /** + * Install HAPs for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * To install an internal beta application, you must have the permission ohos.permission.INSTALL_INTERNALTESTING_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { AsyncCallback } callback - The callback of installing HAPs result. + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. + * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same + *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 17 + */ /** * Install HAPs for an application. * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. @@ -550,7 +646,8 @@ declare namespace installer { * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ install(hapFilePaths: Array, callback: AsyncCallback): void; @@ -754,6 +851,52 @@ declare namespace installer { * @systemapi * @since 13 */ + /** + * Install haps for an application. + * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. + * To install an enterprise application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_BUNDLE. + * To install an enterprise administrator application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE. + * To install an enterprise normal application, you must have the permission ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE. + * To install an internal beta application, you must have the permission ohos.permission.INSTALL_INTERNALTESTING_BUNDLE. + * + * @permission ohos.permission.INSTALL_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE or ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE + * @param { Array } hapFilePaths - Indicates the path where the HAP of the application is stored. + * @param { InstallParam } [installParam] - Indicates other parameters required for the installation. + * @returns { Promise } + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_BUNDLE' or + * 'ohos.permission.INSTALL_ENTERPRISE_MDM_BUNDLE' or 'ohos.permission.INSTALL_ENTERPRISE_NORMAL_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter hapFiles is needed for code signature; 4. The size of specifiedDistributionType is greater than 128; 5. The size of additionalInfo is greater than 3000. + * @throws { BusinessError } 17700004 - The specified user ID is not found. + * @throws { BusinessError } 17700010 - Failed to install the HAP because the HAP fails to be parsed. + * @throws { BusinessError } 17700011 - Failed to install the HAP because the HAP signature fails to be verified. + * @throws { BusinessError } 17700012 - Failed to install the HAP because the HAP path is invalid or the HAP is too large. + * @throws { BusinessError } 17700015 - Failed to install the HAPs because they have different configuration information. + * @throws { BusinessError } 17700016 - Failed to install the HAP because of insufficient system disk space. + * @throws { BusinessError } 17700017 - Failed to install the HAP since the version of the HAP to install is too early. + * @throws { BusinessError } 17700018 - Failed to install because the dependent module does not exist. + * @throws { BusinessError } 17700031 - Failed to install the HAP because the overlay check of the HAP is failed. + * @throws { BusinessError } 17700036 - Failed to install the HSP because lacks appropriate permissions. + * @throws { BusinessError } 17700039 - Failed to install because disallow install a shared bundle by hapFilePaths. + * @throws { BusinessError } 17700041 - Failed to install because enterprise device management disallow install. + * @throws { BusinessError } 17700042 - Failed to install the HAP because of incorrect URI in the data proxy. + * @throws { BusinessError } 17700043 - Failed to install the HAP because of low APL in the non-system data proxy + * (required APL: system_basic or system_core). + * @throws { BusinessError } 17700044 - Failed to install the HAP because the isolationMode configured is not supported. + * @throws { BusinessError } 17700047 - Failed to install the HAP because the VersionCode to be updated is not greater than the current VersionCode. + * @throws { BusinessError } 17700048 - Failed to install the HAP because the code signature verification is failed. + * @throws { BusinessError } 17700050 - Failed to install the HAP because enterprise normal/MDM bundle cannot be installed on non-enterprise device. + * @throws { BusinessError } 17700052 - Failed to install the HAP because debug bundle cannot be installed under non-developer mode. + * @throws { BusinessError } 17700054 - Failed to install the HAP because the HAP requests wrong permissions. + * @throws { BusinessError } 17700058 - Failed to install the HAP because the device has been controlled. + * @throws { BusinessError } 17700066 - Failed to install the HAP because installing the native package failed. + * @throws { BusinessError } 17700073 - Failed to install the HAP because an application with the same + *
bundle name but different signature information exists on the device. + * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 17 + */ /** * Install haps for an application. * To install a non-enterprise application, you must have the permission ohos.permission.INSTALL_BUNDLE. @@ -799,7 +942,8 @@ declare namespace installer { * @throws { BusinessError } 17700077 - Failed to install the HAP and restore to preinstalled bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ install(hapFilePaths: Array, installParam?: InstallParam): Promise; @@ -883,7 +1027,8 @@ declare namespace installer { * @throws { BusinessError } 17700067 - Failed to uninstall the HAP because uninstalling the native package failed. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstall(bundleName: string, installParam: InstallParam, callback: AsyncCallback): void; @@ -939,7 +1084,8 @@ declare namespace installer { * @throws { BusinessError } 17700067 - Failed to uninstall the HAP because uninstalling the native package failed. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstall(bundleName: string, callback: AsyncCallback): void; @@ -1023,7 +1169,8 @@ declare namespace installer { * @throws { BusinessError } 17700067 - Failed to uninstall the HAP because uninstalling the native package failed. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstall(bundleName: string, installParam?: InstallParam): Promise; @@ -1079,7 +1226,8 @@ declare namespace installer { *
bundle name but different signature information exists on the device. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ recover(bundleName: string, installParam: InstallParam, callback: AsyncCallback): void; @@ -1129,7 +1277,8 @@ declare namespace installer { *
bundle name but different signature information exists on the device. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ recover(bundleName: string, callback: AsyncCallback): void; @@ -1185,7 +1334,8 @@ declare namespace installer { *
bundle name but different signature information exists on the device. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ recover(bundleName: string, installParam?: InstallParam): Promise; @@ -1203,7 +1353,8 @@ declare namespace installer { * @throws { BusinessError } 17700038 - The specified shared bundle does not exist. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstall(uninstallParam: UninstallParam, callback: AsyncCallback): void; @@ -1221,7 +1372,8 @@ declare namespace installer { * @throws { BusinessError } 17700038 - The specified shared bundle does not exist. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstall(uninstallParam: UninstallParam): Promise; @@ -1293,7 +1445,8 @@ declare namespace installer { * @throws { BusinessError } 17700051 - Failed to install the HAP because the distribution type of caller application is not enterprise_mdm. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ updateBundleForSelf(hapFilePaths: Array, installParam: InstallParam, callback: AsyncCallback): void; @@ -1357,7 +1510,8 @@ declare namespace installer { * @throws { BusinessError } 17700051 - Failed to install the HAP because the distribution type of caller application is not enterprise_mdm. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ updateBundleForSelf(hapFilePaths: Array, callback: AsyncCallback): void; @@ -1429,7 +1583,8 @@ declare namespace installer { * @throws { BusinessError } 17700051 - Failed to install the HAP because the distribution type of caller application is not enterprise_mdm. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ updateBundleForSelf(hapFilePaths: Array, installParam?: InstallParam): Promise; @@ -1469,7 +1624,8 @@ declare namespace installer { *
bundle name but different signature information exists on the device. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ uninstallUpdates(bundleName: string, installParam?: InstallParam): Promise; @@ -1487,7 +1643,8 @@ declare namespace installer { * @throws { BusinessError } 17700301 - AddExtResource failed due to parse file failed. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ addExtResource(bundleName: string, filePaths: Array): Promise; @@ -1505,7 +1662,8 @@ declare namespace installer { * @throws { BusinessError } 17700302 - RemoveExtResource failed due to module does not exist. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ removeExtResource(bundleName: string, moduleNames: Array): Promise; @@ -1525,9 +1683,10 @@ declare namespace installer { * @throws { BusinessError } 17700069 - The app does not support the creation of an appClone instance. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - createAppClone(bundleName: string, createAppCloneParam?: CreateAppCloneParam): Promise; + createAppClone(bundleName: string, createAppCloneParam?: CreateAppCloneParam): Promise; /** * Destroy clone instance for an application. @@ -1547,7 +1706,7 @@ declare namespace installer { * @systemapi * @since 12 */ - destroyAppClone(bundleName: string, appIndex: number, userId?: number): Promise; + destroyAppClone(bundleName: string, appIndex: number, userId?: number): Promise; /** * Destroy clone instance for an application. @@ -1568,7 +1727,29 @@ declare namespace installer { * @systemapi * @since 15 */ - destroyAppClone(bundleName: string, appIndex: number, destroyAppCloneParam?: DestroyAppCloneParam): Promise; + destroyAppClone(bundleName: string, appIndex: number, destroyAppCloneParam?: DestroyAppCloneParam): Promise; + + /** + * Destroy clone instance for an application. + * + * @permission ohos.permission.UNINSTALL_CLONE_BUNDLE + * @param { string } bundleName - Indicates the bundleName of clone app. + * @param { number } appIndex - Indicates the clone application's index. + * @param { number | DestroyAppCloneParam } [options] - Indicates other parameters required for the uninstallation. + * @returns { Promise } + * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.UNINSTALL_CLONE_BUNDLE'. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. + * @throws { BusinessError } 17700001 - The specified bundleName cannot be found or the bundle is not installed by the specified user. + * @throws { BusinessError } 17700004 - The userId is invalid. + * @throws { BusinessError } 17700061 - AppIndex not in valid range. + * @throws { BusinessError } 17700062 - Failed to uninstall the app because the app is locked. + * @syscap SystemCapability.BundleManager.BundleFramework.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + destroyAppClone(bundleName: string, appIndex: number, options?: number | DestroyAppCloneParam): Promise; /** * Install application by bundle name with specified user. @@ -1604,9 +1785,10 @@ declare namespace installer { *
from being installed on this device or by specified users. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - installPreexistingApp(bundleName: string, userId?: number): Promise; + installPreexistingApp(bundleName: string, userId?: number): Promise; /** * Install plugin for host application. @@ -1618,7 +1800,6 @@ declare namespace installer { * @returns { Promise } * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.INSTALL_PLUGIN_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified hostBundleName cannot be found or the bundle is not installed by the specified user. * @throws { BusinessError } 17700004 - The userId is invalid. * @throws { BusinessError } 17700010 - Failed to install the plugin because the plugin fails to be parsed. @@ -1637,9 +1818,10 @@ declare namespace installer { * @throws { BusinessError } 17700091 - Failed to install the plugin because the plugin name is same as host bundle name. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ - installPlugin(hostBundleName: string, pluginFilePaths: Array, pluginParam?: PluginParam): Promise; + installPlugin(hostBundleName: string, pluginFilePaths: Array, pluginParam?: PluginParam): Promise; /** * Uninstall plugin for host application. @@ -1651,15 +1833,15 @@ declare namespace installer { * @returns { Promise } * @throws { BusinessError } 201 - Calling interface without permission 'ohos.permission.UNINSTALL_PLUGIN_BUNDLE'. * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @throws { BusinessError } 17700004 - The user id is invalid. * @throws { BusinessError } 17700092 - Failed to uninstall the plugin because the specified plugin is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ - uninstallPlugin(hostBundleName: string, pluginBundleName: string, pluginParam?: PluginParam): Promise; + uninstallPlugin(hostBundleName: string, pluginBundleName: string, pluginParam?: PluginParam): Promise; } /** @@ -1668,7 +1850,8 @@ declare namespace installer { * @typedef HashParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface HashParam { /** @@ -1677,7 +1860,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName: string; @@ -1687,7 +1871,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ hashValue: string; } @@ -1731,7 +1916,8 @@ declare namespace installer { * @typedef PGOParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface PGOParam { /** @@ -1740,7 +1926,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ moduleName: string; @@ -1750,7 +1937,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ pgoFilePath: string; } @@ -1761,7 +1949,8 @@ declare namespace installer { * @typedef Parameters * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Parameters { /** @@ -1770,7 +1959,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ key: string; @@ -1780,7 +1970,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ value: string; } @@ -1791,7 +1982,8 @@ declare namespace installer { * @typedef InstallParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface InstallParam { /** @@ -1800,7 +1992,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ userId?: number; @@ -1810,7 +2003,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ installFlag?: number; @@ -1820,7 +2014,8 @@ declare namespace installer { * @type { ?boolean } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isKeepData?: boolean; @@ -1830,7 +2025,8 @@ declare namespace installer { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ hashParams?: Array; @@ -1840,19 +2036,21 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ crowdtestDeadline?: number; /** * Indicates the shared bundle dir paths. * - * @type { ?Array } + * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - sharedBundleDirPaths?: Array; + sharedBundleDirPaths?: Array; /** * Indicates the distribution type specified during bundle installation. @@ -1860,7 +2058,8 @@ declare namespace installer { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ specifiedDistributionType?: string; @@ -1870,7 +2069,8 @@ declare namespace installer { * @type { ?string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ additionalInfo?: string; @@ -1891,7 +2091,8 @@ declare namespace installer { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ pgoParams?: Array; @@ -1901,7 +2102,8 @@ declare namespace installer { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Array; } @@ -1912,7 +2114,8 @@ declare namespace installer { * @typedef UninstallParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface UninstallParam { /** @@ -1921,7 +2124,8 @@ declare namespace installer { * @type { string } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -1931,7 +2135,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ versionCode?: number; } @@ -1942,7 +2147,8 @@ declare namespace installer { * @typedef CreateAppCloneParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface CreateAppCloneParam { /** @@ -1951,7 +2157,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ userId?: number; /** @@ -1960,7 +2167,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ appIndex?: number; } @@ -1971,7 +2179,8 @@ declare namespace installer { * @typedef DestroyAppCloneParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface DestroyAppCloneParam { /** @@ -1980,7 +2189,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ userId?: number; /** @@ -1989,7 +2199,8 @@ declare namespace installer { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Array; } @@ -2000,7 +2211,8 @@ declare namespace installer { * @typedef PluginParam * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface PluginParam { /** @@ -2009,7 +2221,8 @@ declare namespace installer { * @type { ?number } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ userId?: number; @@ -2019,7 +2232,8 @@ declare namespace installer { * @type { ?Array } * @syscap SystemCapability.BundleManager.BundleFramework.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ parameters?: Array; } diff --git a/api/@ohos.bundle.launcherBundleManager.d.ts b/api/@ohos.bundle.launcherBundleManager.d.ts index 604d60397513b6ae3598546f16c68524f13e1864..fca170eee8c7aa5ce23d075c1da3e7d475777ec7 100644 --- a/api/@ohos.bundle.launcherBundleManager.d.ts +++ b/api/@ohos.bundle.launcherBundleManager.d.ts @@ -21,14 +21,15 @@ import { AsyncCallback } from './@ohos.base'; import { LauncherAbilityInfo as _LauncherAbilityInfo } from './bundleManager/LauncherAbilityInfo'; import { ShortcutInfo as _ShortcutInfo, ShortcutWant as _ShortcutWant, ParameterItem as _ParameterItem } from './bundleManager/ShortcutInfo'; -import { StartOptions } from './@ohos.app.ability.StartOptions'; +import StartOptions from './@ohos.app.ability.StartOptions'; /** * Launcher bundle manager. * * @namespace launcherBundleManager * @syscap SystemCapability.BundleManager.BundleFramework.Launcher - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace launcherBundleManager { /** @@ -46,7 +47,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLauncherAbilityInfo(bundleName: string, userId: number, callback: AsyncCallback>): void; @@ -66,7 +68,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLauncherAbilityInfo(bundleName: string, userId: number): Promise>; @@ -78,12 +81,12 @@ declare namespace launcherBundleManager { * @param { number } userId - Indicates the id for the user. * @returns { Array } the LauncherAbilityInfo object. * @throws { BusinessError } 201 - Verify permission denied. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not support. * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getLauncherAbilityInfoSync(bundleName: string, userId: number): Array; @@ -100,7 +103,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllLauncherAbilityInfo(userId: number, callback: AsyncCallback>): void; @@ -117,7 +121,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllLauncherAbilityInfo(userId: number): Promise>; @@ -134,7 +139,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getShortcutInfo(bundleName: string, callback: AsyncCallback>): void; @@ -151,7 +157,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getShortcutInfo(bundleName: string): Promise>; @@ -168,7 +175,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getShortcutInfoSync(bundleName: string): Array; @@ -188,7 +196,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ function getShortcutInfoSync(bundleName: string, userId: number): Array; @@ -206,7 +215,8 @@ declare namespace launcherBundleManager { * @throws { BusinessError } 17700065 - The specified shortcut want in shortcut info is not supported to be started. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function startShortcut(shortcutInfo: ShortcutInfo, options?: StartOptions): Promise; @@ -215,7 +225,8 @@ declare namespace launcherBundleManager { * * @typedef { _LauncherAbilityInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export type LauncherAbilityInfo = _LauncherAbilityInfo; @@ -225,7 +236,8 @@ declare namespace launcherBundleManager { * @typedef { _ShortcutInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ShortcutInfo = _ShortcutInfo; /** @@ -234,7 +246,8 @@ declare namespace launcherBundleManager { * @typedef { _ShortcutWant } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ShortcutWant = _ShortcutWant; /** @@ -243,7 +256,8 @@ declare namespace launcherBundleManager { * @typedef { _ParameterItem } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ParameterItem = _ParameterItem; } diff --git a/api/@ohos.bundle.overlay.d.ts b/api/@ohos.bundle.overlay.d.ts old mode 100755 new mode 100644 index 2267ea00e5af3b67d9244f493ed8ce0b8c701309..95e7ed8d176f1948a79ae8f7977f50d59673bfd4 --- a/api/@ohos.bundle.overlay.d.ts +++ b/api/@ohos.bundle.overlay.d.ts @@ -19,14 +19,20 @@ */ import { AsyncCallback } from './@ohos.base'; +/*** if arkts 1.1 */ import * as _OverlayModuleInfo from './bundleManager/OverlayModuleInfo'; +/*** endif */ +/*** if arkts 1.2 */ +import { OverlayModuleInfo as _OverlayModuleInfo } from './bundleManager/OverlayModuleInfo'; +/*** endif */ /** * Used for application interception overlay * * @namespace overlay * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace overlay { /** @@ -39,7 +45,8 @@ declare namespace overlay { * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setOverlayEnabled(moduleName: string, isEnabled: boolean, callback: AsyncCallback): void; @@ -53,7 +60,8 @@ declare namespace overlay { * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setOverlayEnabled(moduleName: string, isEnabled: boolean): Promise; @@ -74,7 +82,8 @@ declare namespace overlay { * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setOverlayEnabledByBundleName(bundleName: string, moduleName: string, isEnabled: boolean, callback: AsyncCallback): void; @@ -96,7 +105,8 @@ declare namespace overlay { * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setOverlayEnabledByBundleName(bundleName: string, moduleName: string, isEnabled: boolean): Promise; @@ -110,7 +120,8 @@ declare namespace overlay { * @throws { BusinessError } 17700032 - The specified bundle does not contain any overlay module. * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOverlayModuleInfo(moduleName: string, callback: AsyncCallback): void; @@ -124,7 +135,8 @@ declare namespace overlay { * @throws { BusinessError } 17700032 - The specified bundle does not contain any overlay module. * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOverlayModuleInfo(moduleName: string): Promise; @@ -137,7 +149,8 @@ declare namespace overlay { * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700034 - The specified module is an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTargetOverlayModuleInfos(targetModuleName: string, callback: AsyncCallback>): void; @@ -151,7 +164,8 @@ declare namespace overlay { * @throws { BusinessError } 17700002 - The specified module name is not found. * @throws { BusinessError } 17700034 - The specified module is an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTargetOverlayModuleInfos(targetModuleName: string): Promise>; @@ -168,7 +182,8 @@ declare namespace overlay { * @throws { BusinessError } 17700032 - The specified bundle does not contain any overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOverlayModuleInfoByBundleName(bundleName: string, callback: AsyncCallback>): void; @@ -189,7 +204,8 @@ declare namespace overlay { * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOverlayModuleInfoByBundleName(bundleName: string, moduleName: string, callback: AsyncCallback>): void; @@ -210,7 +226,8 @@ declare namespace overlay { * @throws { BusinessError } 17700033 - The specified module is not an overlay module. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getOverlayModuleInfoByBundleName(bundleName: string, moduleName?: string): Promise>; @@ -228,7 +245,8 @@ declare namespace overlay { * @throws { BusinessError } 17700035 - The specified bundle is an overlay bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTargetOverlayModuleInfosByBundleName(targetBundleName: string, callback: AsyncCallback>): void; @@ -249,7 +267,8 @@ declare namespace overlay { * @throws { BusinessError } 17700035 - The specified bundle is an overlay bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName: string, callback: AsyncCallback>): void; @@ -270,7 +289,8 @@ declare namespace overlay { * @throws { BusinessError } 17700035 - The specified bundle is an overlay bundle. * @syscap SystemCapability.BundleManager.BundleFramework.Overlay * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName?: string): Promise>; @@ -283,6 +303,16 @@ declare namespace overlay { * @since 10 */ export type OverlayModuleInfo = _OverlayModuleInfo.OverlayModuleInfo; + + /** + * Obtains configuration information about a overlay hap module. + * + * @typedef { _OverlayModuleInfo } + * @syscap SystemCapability.BundleManager.BundleFramework.Overlay + * @since 20 + * @arkts 1.2 + */ + export type OverlayModuleInfo = _OverlayModuleInfo; } export default overlay; diff --git a/api/@ohos.bundle.shortcutManager.d.ts b/api/@ohos.bundle.shortcutManager.d.ts index 7b303deb36e88c92f42354a1ac03d8d1f484746b..df987404eff940c5719b97fa561d8f16f6a5c98a 100644 --- a/api/@ohos.bundle.shortcutManager.d.ts +++ b/api/@ohos.bundle.shortcutManager.d.ts @@ -26,7 +26,8 @@ import { ShortcutInfo as _ShortcutInfo, ShortcutWant as _ShortcutWant, Parameter * @namespace shortcutManager * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace shortcutManager { /** @@ -39,17 +40,18 @@ declare namespace shortcutManager { * @throws { BusinessError } 201 - Verify permission denied. * @throws { BusinessError } 202 - Permission denied, non-system app called system api. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. - * @throws { BusinessError } 17700001 - The specified bundle name is not found. + * @throws { BusinessError } 17700001 - The specified bundle name is not found. * @throws { BusinessError } 17700004 - The specified user ID is not found. * @throws { BusinessError } 17700026 - The specified bundle is disabled. * @throws { BusinessError } 17700061 - The specified app index is invalid. * @throws { BusinessError } 17700070 - The specified shortcut id is illegal. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function addDesktopShortcutInfo(shortcutInfo: ShortcutInfo, userId: number): Promise; - + /** * Delete desktop shortcut info. * @@ -63,10 +65,11 @@ declare namespace shortcutManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteDesktopShortcutInfo(shortcutInfo: ShortcutInfo, userId: number): Promise; - + /** * Get all desktop shortcut info. * @@ -79,7 +82,8 @@ declare namespace shortcutManager { * @throws { BusinessError } 17700004 - The specified user ID is not found. * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllDesktopShortcutInfo(userId: number): Promise>; @@ -89,7 +93,8 @@ declare namespace shortcutManager { * @typedef { _ShortcutInfo } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ShortcutInfo = _ShortcutInfo; /** @@ -98,7 +103,8 @@ declare namespace shortcutManager { * @typedef { _ShortcutWant } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ShortcutWant = _ShortcutWant; /** @@ -107,7 +113,8 @@ declare namespace shortcutManager { * @typedef { _ParameterItem } * @syscap SystemCapability.BundleManager.BundleFramework.Launcher * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type ParameterItem = _ParameterItem; } diff --git a/api/@ohos.charger.d.ts b/api/@ohos.charger.d.ts index a02a52cfd5b514f0e3d6d660c5bb9bb8b17ecf7c..215a92866e78004841a9347e4aa7f1a3130ca6ef 100644 --- a/api/@ohos.charger.d.ts +++ b/api/@ohos.charger.d.ts @@ -16,6 +16,7 @@ /** * @file * @kit BasicServicesKit + * @arkts 1.1&1.2 */ /** @@ -24,7 +25,8 @@ * @namespace charger * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace charger { /** @@ -33,7 +35,8 @@ declare namespace charger { * @enum { number } * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ChargeType { /** @@ -41,7 +44,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE, /** @@ -49,7 +53,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ WIRED_NORMAL, /** @@ -57,7 +62,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ WIRED_QUICK, /** @@ -65,7 +71,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ WIRED_SUPER_QUICK, /** @@ -73,7 +80,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ WIRELESS_NORMAL, /** @@ -81,7 +89,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ WIRELESS_QUICK, /** @@ -89,7 +98,8 @@ declare namespace charger { * * @syscap SystemCapability.PowerManager.BatteryManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ WIRELESS_SUPER_QUICK } diff --git a/api/@ohos.commonEventManager.d.ts b/api/@ohos.commonEventManager.d.ts index 4cf9fe240196ce66490278206ff7bd1ac53204ab..66e983a7611d0637986d511c562c0fe022aac4f3 100644 --- a/api/@ohos.commonEventManager.d.ts +++ b/api/@ohos.commonEventManager.d.ts @@ -38,7 +38,8 @@ import { CommonEventPublishData as _CommonEventPublishData } from './commonEvent * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace commonEventManager { /** @@ -84,9 +85,10 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function publish(event: string, callback: AsyncCallback): void; + export function publish(event: string, callback: AsyncCallback): void; /** * Publishes an ordered, sticky, or standard common event. @@ -137,9 +139,10 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function publish(event: string, options: CommonEventPublishData, callback: AsyncCallback): void; + export function publish(event: string, options: CommonEventPublishData, callback: AsyncCallback): void; /** * Publishes an ordered, sticky, or standard common event to a specified user. @@ -158,7 +161,27 @@ declare namespace commonEventManager { * @systemapi * @since 9 */ - function publishAsUser(event: string, userId: number, callback: AsyncCallback): void; + /** + * Publishes an ordered, sticky, or standard common event to a specified user. + * + * @param { string } event - Specified the names of the common events. + * @param { number } userId - Specified the user to receive the common events. + * @param { AsyncCallback } callback - The callback of publishAsUser. + * @throws { BusinessError } 202 - not system app + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. + * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. + * @throws { BusinessError } 1500008 - Failed to initialize the common event service. + * @throws { BusinessError } 1500009 - Failed to obtain system parameters. + * @syscap SystemCapability.Notification.CommonEvent + * @systemapi + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 + */ + export function publishAsUser(event: string, userId: number, callback: AsyncCallback): void; /** * Publishes an ordered, sticky, or standard common event to a specified user. @@ -179,7 +202,29 @@ declare namespace commonEventManager { * @systemapi * @since 9 */ - function publishAsUser( + /** + * Publishes an ordered, sticky, or standard common event to a specified user. + * + * @param { string } event - Specified the names of the common events. + * @param { number } userId - Specified the user to receive the common events. + * @param { CommonEventPublishData } options - Indicates the CommonEventPublishData containing the common event + * content and attributes. + * @param { AsyncCallback } callback - The callback of publishAsUser. + * @throws { BusinessError } 202 - not system app + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 1500004 - A third-party application cannot send system common events. + * @throws { BusinessError } 1500007 - Failed to send the message to the common event service. + * @throws { BusinessError } 1500008 - Failed to initialize the common event service. + * @throws { BusinessError } 1500009 - Failed to obtain system parameters. + * @syscap SystemCapability.Notification.CommonEvent + * @systemapi + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 + */ + export function publishAsUser( event: string, userId: number, options: CommonEventPublishData, @@ -208,9 +253,10 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function createSubscriber( + export function createSubscriber( subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback ): void; @@ -235,9 +281,10 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise; + export function createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise; /** * Creates a CommonEventSubscriber for the SubscriberInfo. @@ -258,9 +305,10 @@ declare namespace commonEventManager { *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function createSubscriberSync(subscribeInfo: CommonEventSubscribeInfo): CommonEventSubscriber; + export function createSubscriberSync(subscribeInfo: CommonEventSubscribeInfo): CommonEventSubscriber; /** * Subscribe an ordered, sticky, or standard common event. @@ -288,9 +336,10 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void; + export function subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback): void; /** * Unsubscribe from an ordered, sticky, or standard common event. @@ -318,9 +367,10 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): void; + export function unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback): void; /** * Remove sticky common event. @@ -337,7 +387,8 @@ declare namespace commonEventManager { * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeStickyCommonEvent(event: string, callback: AsyncCallback): void; @@ -356,7 +407,8 @@ declare namespace commonEventManager { * @throws { BusinessError } 1500008 - Failed to initialize the common event service. * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeStickyCommonEvent(event: string): Promise; @@ -373,7 +425,8 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @systemapi Hide this for inner system use. * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setStaticSubscriberState(enable: boolean, callback: AsyncCallback): void; @@ -390,7 +443,8 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @systemapi Hide this for inner system use. * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function setStaticSubscriberState(enable: boolean): Promise; @@ -408,7 +462,8 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @systemapi Hide this for inner system use. * @StageModelOnly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function setStaticSubscriberState(enable: boolean, events?: Array): Promise; @@ -425,7 +480,8 @@ declare namespace commonEventManager { * @enum { string } * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum Support { /** @@ -433,7 +489,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BOOT_COMPLETED = 'usual.event.BOOT_COMPLETED', @@ -441,7 +498,8 @@ declare namespace commonEventManager { * This commonEvent means when the device finnish booting, but still in the locked state. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_LOCKED_BOOT_COMPLETED = 'usual.event.LOCKED_BOOT_COMPLETED', @@ -449,7 +507,8 @@ declare namespace commonEventManager { * This commonEvent means when the device is shutting down, note: turn off, not sleeping. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SHUTDOWN = 'usual.event.SHUTDOWN', @@ -457,7 +516,8 @@ declare namespace commonEventManager { * This commonEvent means when the charging state, level and so on about the battery. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BATTERY_CHANGED = 'usual.event.BATTERY_CHANGED', @@ -465,7 +525,8 @@ declare namespace commonEventManager { * This commonEvent means when the device in low battery state.. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BATTERY_LOW = 'usual.event.BATTERY_LOW', @@ -473,7 +534,8 @@ declare namespace commonEventManager { * This commonEvent means when the battery level is an ok state. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BATTERY_OKAY = 'usual.event.BATTERY_OKAY', @@ -481,7 +543,8 @@ declare namespace commonEventManager { * This commonEvent means when the other power is connected to the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_POWER_CONNECTED = 'usual.event.POWER_CONNECTED', @@ -489,7 +552,8 @@ declare namespace commonEventManager { * This commonEvent means when the other power is removed from the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_POWER_DISCONNECTED = 'usual.event.POWER_DISCONNECTED', @@ -497,7 +561,8 @@ declare namespace commonEventManager { * This commonEvent means when the screen is turned off. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SCREEN_OFF = 'usual.event.SCREEN_OFF', @@ -505,7 +570,8 @@ declare namespace commonEventManager { * This commonEvent means when the device is awakened and interactive. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SCREEN_ON = 'usual.event.SCREEN_ON', @@ -513,7 +579,8 @@ declare namespace commonEventManager { * This commonEvent means when the thermal state level change * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_THERMAL_LEVEL_CHANGED = 'usual.event.THERMAL_LEVEL_CHANGED', @@ -521,7 +588,8 @@ declare namespace commonEventManager { * This commonEvent means when the device is about to enter the force sleep mode * * @syscap SystemCapability.Notification.CommonEvent - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_ENTER_FORCE_SLEEP = 'usual.event.ENTER_FORCE_SLEEP', @@ -529,7 +597,8 @@ declare namespace commonEventManager { * This commonEvent means when the device exits the force sleep mode * * @syscap SystemCapability.Notification.CommonEvent - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_EXIT_FORCE_SLEEP = 'usual.event.EXIT_FORCE_SLEEP', @@ -537,7 +606,8 @@ declare namespace commonEventManager { * This commonEvent means when the device is about to enter the hibernate mode * * @syscap SystemCapability.Notification.CommonEvent - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_ENTER_HIBERNATE = 'usual.event.ENTER_HIBERNATE', @@ -545,7 +615,8 @@ declare namespace commonEventManager { * This commonEvent means when the device exits the hibernate mode * * @syscap SystemCapability.Notification.CommonEvent - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_EXIT_HIBERNATE = 'usual.event.EXIT_HIBERNATE', @@ -562,7 +633,8 @@ declare namespace commonEventManager { * This commonEvent means when the current time is changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_TIME_TICK = 'usual.event.TIME_TICK', @@ -570,7 +642,8 @@ declare namespace commonEventManager { * This commonEvent means when the time is set. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_TIME_CHANGED = 'usual.event.TIME_CHANGED', @@ -578,7 +651,8 @@ declare namespace commonEventManager { * This commonEvent means when the current date is changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DATE_CHANGED = 'usual.event.DATE_CHANGED', @@ -586,7 +660,8 @@ declare namespace commonEventManager { * This commonEvent means when the time zone is changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_TIMEZONE_CHANGED = 'usual.event.TIMEZONE_CHANGED', @@ -594,7 +669,8 @@ declare namespace commonEventManager { * This commonEvent means when the dialog to dismiss. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CLOSE_SYSTEM_DIALOGS = 'usual.event.CLOSE_SYSTEM_DIALOGS', @@ -602,7 +678,8 @@ declare namespace commonEventManager { * This commonEvent means when a new application package is installed on the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_ADDED = 'usual.event.PACKAGE_ADDED', @@ -611,7 +688,8 @@ declare namespace commonEventManager { * replace the old version.the data contains the name of the package. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_REPLACED = 'usual.event.PACKAGE_REPLACED', @@ -620,7 +698,8 @@ declare namespace commonEventManager { * replace the old version, it does not contain additional data and only be sent to the replaced application. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MY_PACKAGE_REPLACED = 'usual.event.MY_PACKAGE_REPLACED', @@ -628,7 +707,8 @@ declare namespace commonEventManager { * This commonEvent means when an existing application package is removed from the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_REMOVED = 'usual.event.PACKAGE_REMOVED', @@ -636,7 +716,8 @@ declare namespace commonEventManager { * This commonEvent means when an existing application package is removed from the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BUNDLE_REMOVED = 'usual.event.BUNDLE_REMOVED', @@ -644,7 +725,8 @@ declare namespace commonEventManager { * This commonEvent means when an existing application package is completely removed from the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_FULLY_REMOVED = 'usual.event.PACKAGE_FULLY_REMOVED', @@ -652,7 +734,8 @@ declare namespace commonEventManager { * This commonEvent means when an existing application package has been changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_CHANGED = 'usual.event.PACKAGE_CHANGED', @@ -660,7 +743,8 @@ declare namespace commonEventManager { * This commonEvent means the user has restarted a package, and all of its processes have been killed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_RESTARTED = 'usual.event.PACKAGE_RESTARTED', @@ -668,7 +752,8 @@ declare namespace commonEventManager { * This commonEvent means the user has cleared the package data. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_DATA_CLEARED = 'usual.event.PACKAGE_DATA_CLEARED', @@ -676,7 +761,8 @@ declare namespace commonEventManager { * This commonEvent means the user has cleared the package cache. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_CACHE_CLEARED = 'usual.event.PACKAGE_CACHE_CLEARED', @@ -684,7 +770,8 @@ declare namespace commonEventManager { * This commonEvent means the packages have been suspended. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGES_SUSPENDED = 'usual.event.PACKAGES_SUSPENDED', @@ -692,7 +779,8 @@ declare namespace commonEventManager { * This commonEvent means the packages have been un-suspended. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGES_UNSUSPENDED = 'usual.event.PACKAGES_UNSUSPENDED', @@ -700,7 +788,8 @@ declare namespace commonEventManager { * This commonEvent Sent to a package that has been suspended by the system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MY_PACKAGE_SUSPENDED = 'usual.event.MY_PACKAGE_SUSPENDED', @@ -708,7 +797,8 @@ declare namespace commonEventManager { * Sent to a package that has been un-suspended. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MY_PACKAGE_UNSUSPENDED = 'usual.event.MY_PACKAGE_UNSUSPENDED', @@ -716,7 +806,8 @@ declare namespace commonEventManager { * A user id has been removed from the system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_UID_REMOVED = 'usual.event.UID_REMOVED', @@ -724,7 +815,8 @@ declare namespace commonEventManager { * The application is first launched after installed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_FIRST_LAUNCH = 'usual.event.PACKAGE_FIRST_LAUNCH', @@ -732,7 +824,8 @@ declare namespace commonEventManager { * Sent by system package verifier when a package need to be verified. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_NEEDS_VERIFICATION = 'usual.event.PACKAGE_NEEDS_VERIFICATION', @@ -740,7 +833,8 @@ declare namespace commonEventManager { * Sent by system package verifier when a package is verified. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_VERIFIED = 'usual.event.PACKAGE_VERIFIED', @@ -749,7 +843,8 @@ declare namespace commonEventManager { * available since the media on which they exist is available. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_EXTERNAL_APPLICATIONS_AVAILABLE = 'usual.event.EXTERNAL_APPLICATIONS_AVAILABLE', @@ -757,7 +852,8 @@ declare namespace commonEventManager { * Resources for a set of packages are currently unavailable since the media on which they exist is unavailable. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_EXTERNAL_APPLICATIONS_UNAVAILABLE = 'usual.event.EXTERNAL_APPLICATIONS_UNAVAILABLE', @@ -765,7 +861,8 @@ declare namespace commonEventManager { * The device configuration such as orientation,locale have been changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CONFIGURATION_CHANGED = 'usual.event.CONFIGURATION_CHANGED', @@ -773,7 +870,8 @@ declare namespace commonEventManager { * The current device's locale has changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_LOCALE_CHANGED = 'usual.event.LOCALE_CHANGED', @@ -781,7 +879,8 @@ declare namespace commonEventManager { * Indicates low memory condition notification acknowledged by user and package management should be started. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MANAGE_PACKAGE_STORAGE = 'usual.event.MANAGE_PACKAGE_STORAGE', @@ -789,7 +888,8 @@ declare namespace commonEventManager { * Send by the smart function when the system in drive mode. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DRIVE_MODE = 'common.event.DRIVE_MODE', @@ -797,7 +897,8 @@ declare namespace commonEventManager { * Send by the smart function when the system in home mode. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_HOME_MODE = 'common.event.HOME_MODE', @@ -805,7 +906,8 @@ declare namespace commonEventManager { * Send by the smart function when the system in office mode. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_OFFICE_MODE = 'common.event.OFFICE_MODE', @@ -813,7 +915,8 @@ declare namespace commonEventManager { * Remind new user of preparing to start. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_STARTED = 'usual.event.USER_STARTED', @@ -821,7 +924,8 @@ declare namespace commonEventManager { * Remind previous user of that the service has been the background. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_BACKGROUND = 'usual.event.USER_BACKGROUND', @@ -829,7 +933,8 @@ declare namespace commonEventManager { * Remind new user of that the service has been the foreground. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_FOREGROUND = 'usual.event.USER_FOREGROUND', @@ -838,7 +943,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_SWITCHED = 'usual.event.USER_SWITCHED', @@ -847,7 +953,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_STARTING = 'usual.event.USER_STARTING', @@ -855,7 +962,8 @@ declare namespace commonEventManager { * Remind new user of that the service has been unlocked. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_UNLOCKED = 'usual.event.USER_UNLOCKED', @@ -864,7 +972,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_STOPPING = 'usual.event.USER_STOPPING', @@ -872,7 +981,8 @@ declare namespace commonEventManager { * Remind new user of that the service has stopped. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_STOPPED = 'usual.event.USER_STOPPED', @@ -887,7 +997,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGIN = 'common.event.DISTRIBUTED_ACCOUNT_LOGIN', @@ -902,7 +1013,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOUT = 'common.event.DISTRIBUTED_ACCOUNT_LOGOUT', @@ -917,7 +1029,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_TOKEN_INVALID = 'common.event.DISTRIBUTED_ACCOUNT_TOKEN_INVALID', @@ -932,7 +1045,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISTRIBUTED_ACCOUNT_LOGOFF = 'common.event.DISTRIBUTED_ACCOUNT_LOGOFF', @@ -940,7 +1054,8 @@ declare namespace commonEventManager { * WIFI state. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_POWER_STATE = 'usual.event.wifi.POWER_STATE', @@ -948,7 +1063,8 @@ declare namespace commonEventManager { * WIFI scan results. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_SCAN_FINISHED = 'usual.event.wifi.SCAN_FINISHED', @@ -956,7 +1072,8 @@ declare namespace commonEventManager { * WIFI RSSI change. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_RSSI_VALUE = 'usual.event.wifi.RSSI_VALUE', @@ -964,7 +1081,8 @@ declare namespace commonEventManager { * WIFI connect state. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_CONN_STATE = 'usual.event.wifi.CONN_STATE', @@ -972,7 +1090,8 @@ declare namespace commonEventManager { * WIFI hotspot state. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_HOTSPOT_STATE = 'usual.event.wifi.HOTSPOT_STATE', @@ -980,7 +1099,8 @@ declare namespace commonEventManager { * WIFI ap sta join. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_AP_STA_JOIN = 'usual.event.wifi.WIFI_HS_STA_JOIN', @@ -988,7 +1108,8 @@ declare namespace commonEventManager { * WIFI ap sta join. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_AP_STA_LEAVE = 'usual.event.wifi.WIFI_HS_STA_LEAVE', @@ -996,7 +1117,8 @@ declare namespace commonEventManager { * Indicates Wi-Fi MpLink state notification acknowledged by binding or unbinding MpLink. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_MPLINK_STATE_CHANGE = 'usual.event.wifi.mplink.STATE_CHANGE', @@ -1004,7 +1126,8 @@ declare namespace commonEventManager { * Indicates Wi-Fi P2P connection state notification acknowledged by connecting or disconnected P2P. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_P2P_CONN_STATE = 'usual.event.wifi.p2p.CONN_STATE_CHANGE', @@ -1012,7 +1135,8 @@ declare namespace commonEventManager { * Indicates that the Wi-Fi P2P state change. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_P2P_STATE_CHANGED = 'usual.event.wifi.p2p.STATE_CHANGE', @@ -1020,7 +1144,8 @@ declare namespace commonEventManager { * Indicates that the Wi-Fi P2P peers state change. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_P2P_PEERS_STATE_CHANGED = 'usual.event.wifi.p2p.DEVICES_CHANGE', @@ -1028,7 +1153,8 @@ declare namespace commonEventManager { * Indicates that the Wi-Fi P2P discovery state change. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_P2P_PEERS_DISCOVERY_STATE_CHANGED = 'usual.event.wifi.p2p.PEER_DISCOVERY_STATE_CHANGE', @@ -1036,7 +1162,8 @@ declare namespace commonEventManager { * Indicates that the Wi-Fi P2P current device state change. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_P2P_CURRENT_DEVICE_STATE_CHANGED = 'usual.event.wifi.p2p.CURRENT_DEVICE_CHANGE', @@ -1044,7 +1171,8 @@ declare namespace commonEventManager { * Indicates that the Wi-Fi P2P group info is changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_WIFI_P2P_GROUP_STATE_CHANGED = 'usual.event.wifi.p2p.GROUP_STATE_CHANGED', @@ -1052,7 +1180,8 @@ declare namespace commonEventManager { * Bluetooth.handsfree.ag.connect.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CONNECT_STATE_UPDATE = 'usual.event.bluetooth.handsfree.ag.CONNECT_STATE_UPDATE', @@ -1060,7 +1189,8 @@ declare namespace commonEventManager { * Bluetooth.handsfree.ag.current.device.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_CURRENT_DEVICE_UPDATE = 'usual.event.bluetooth.handsfree.ag.CURRENT_DEVICE_UPDATE', @@ -1068,7 +1198,8 @@ declare namespace commonEventManager { * Bluetooth.handsfree.ag.audio.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREE_AG_AUDIO_STATE_UPDATE = 'usual.event.bluetooth.handsfree.ag.AUDIO_STATE_UPDATE', @@ -1076,7 +1207,8 @@ declare namespace commonEventManager { * Bluetooth.a2dpsource.connect.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CONNECT_STATE_UPDATE = 'usual.event.bluetooth.a2dpsource.CONNECT_STATE_UPDATE', @@ -1084,7 +1216,8 @@ declare namespace commonEventManager { * Bluetooth.a2dpsource.current.device.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CURRENT_DEVICE_UPDATE = 'usual.event.bluetooth.a2dpsource.CURRENT_DEVICE_UPDATE', @@ -1092,7 +1225,8 @@ declare namespace commonEventManager { * Bluetooth.a2dpsource.playing.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSOURCE_PLAYING_STATE_UPDATE = 'usual.event.bluetooth.a2dpsource.PLAYING_STATE_UPDATE', @@ -1100,7 +1234,8 @@ declare namespace commonEventManager { * Bluetooth.a2dpsource.avrcp.connect.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSOURCE_AVRCP_CONNECT_STATE_UPDATE = 'usual.event.bluetooth.a2dpsource.AVRCP_CONNECT_STATE_UPDATE', @@ -1108,7 +1243,8 @@ declare namespace commonEventManager { * Bluetooth.a2dpsource.codec.value.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSOURCE_CODEC_VALUE_UPDATE = 'usual.event.bluetooth.a2dpsource.CODEC_VALUE_UPDATE', @@ -1116,7 +1252,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.discovered. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_DISCOVERED = 'usual.event.bluetooth.remotedevice.DISCOVERED', @@ -1124,7 +1261,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.class.value.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CLASS_VALUE_UPDATE = 'usual.event.bluetooth.remotedevice.CLASS_VALUE_UPDATE', @@ -1132,7 +1270,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.acl.connected. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_CONNECTED = 'usual.event.bluetooth.remotedevice.ACL_CONNECTED', @@ -1140,7 +1279,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.acl.disconnected. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_ACL_DISCONNECTED = 'usual.event.bluetooth.remotedevice.ACL_DISCONNECTED', @@ -1148,7 +1288,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.name.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_NAME_UPDATE = 'usual.event.bluetooth.remotedevice.NAME_UPDATE', @@ -1156,7 +1297,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.pair.state. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIR_STATE = 'usual.event.bluetooth.remotedevice.PAIR_STATE', @@ -1164,7 +1306,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.battery.value.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_BATTERY_VALUE_UPDATE = 'usual.event.bluetooth.remotedevice.BATTERY_VALUE_UPDATE', @@ -1172,7 +1315,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.sdp.result. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_SDP_RESULT = 'usual.event.bluetooth.remotedevice.SDP_RESULT', @@ -1180,7 +1324,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.uuid.value. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_UUID_VALUE = 'usual.event.bluetooth.remotedevice.UUID_VALUE', @@ -1188,7 +1333,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.pairing.req. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_REQ = 'usual.event.bluetooth.remotedevice.PAIRING_REQ', @@ -1196,7 +1342,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.pairing.cancel. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_PAIRING_CANCEL = 'usual.event.bluetooth.remotedevice.PAIRING_CANCEL', @@ -1204,7 +1351,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.connect.req. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REQ = 'usual.event.bluetooth.remotedevice.CONNECT_REQ', @@ -1212,7 +1360,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.connect.reply. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_REPLY = 'usual.event.bluetooth.remotedevice.CONNECT_REPLY', @@ -1220,7 +1369,8 @@ declare namespace commonEventManager { * Bluetooth.remotedevice.connect.cancel. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_REMOTEDEVICE_CONNECT_CANCEL = 'usual.event.bluetooth.remotedevice.CONNECT_CANCEL', @@ -1228,7 +1378,8 @@ declare namespace commonEventManager { * Bluetooth.handsfreeunit.connect.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_CONNECT_STATE_UPDATE = 'usual.event.bluetooth.handsfreeunit.CONNECT_STATE_UPDATE', @@ -1236,7 +1387,8 @@ declare namespace commonEventManager { * Bluetooth.handsfreeunit.audio.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AUDIO_STATE_UPDATE = 'usual.event.bluetooth.handsfreeunit.AUDIO_STATE_UPDATE', @@ -1244,7 +1396,8 @@ declare namespace commonEventManager { * Bluetooth.handsfreeunit.ag.common.event. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_COMMON_EVENT = 'usual.event.bluetooth.handsfreeunit.AG_COMMON_EVENT', @@ -1252,7 +1405,8 @@ declare namespace commonEventManager { * Bluetooth.handsfreeunit.ag.call.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HANDSFREEUNIT_AG_CALL_STATE_UPDATE = 'usual.event.bluetooth.handsfreeunit.AG_CALL_STATE_UPDATE', @@ -1260,7 +1414,8 @@ declare namespace commonEventManager { * Bluetooth.host.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_STATE_UPDATE = 'usual.event.bluetooth.host.STATE_UPDATE', @@ -1268,7 +1423,8 @@ declare namespace commonEventManager { * Bluetooth.host.req.discoverable. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_REQ_DISCOVERABLE = 'usual.event.bluetooth.host.REQ_DISCOVERABLE', @@ -1276,7 +1432,8 @@ declare namespace commonEventManager { * Bluetooth.host.req.enable. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_REQ_ENABLE = 'usual.event.bluetooth.host.REQ_ENABLE', @@ -1284,7 +1441,8 @@ declare namespace commonEventManager { * Bluetooth.host.req.disable. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_REQ_DISABLE = 'usual.event.bluetooth.host.REQ_DISABLE', @@ -1292,7 +1450,8 @@ declare namespace commonEventManager { * Bluetooth.host.scan.mode.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_SCAN_MODE_UPDATE = 'usual.event.bluetooth.host.SCAN_MODE_UPDATE', @@ -1300,7 +1459,8 @@ declare namespace commonEventManager { * Bluetooth.host.discovery.stated. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_STARTED = 'usual.event.bluetooth.host.DISCOVERY_STARTED', @@ -1308,7 +1468,8 @@ declare namespace commonEventManager { * Bluetooth.host.discovery.finished. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_DISCOVERY_FINISHED = 'usual.event.bluetooth.host.DISCOVERY_FINISHED', @@ -1316,7 +1477,8 @@ declare namespace commonEventManager { * Bluetooth.host.name.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_HOST_NAME_UPDATE = 'usual.event.bluetooth.host.NAME_UPDATE', @@ -1324,7 +1486,8 @@ declare namespace commonEventManager { * Bluetooth.a2dp.connect.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSINK_CONNECT_STATE_UPDATE = 'usual.event.bluetooth.a2dpsink.CONNECT_STATE_UPDATE', @@ -1332,7 +1495,8 @@ declare namespace commonEventManager { * Bluetooth.a2dp.playing.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSINK_PLAYING_STATE_UPDATE = 'usual.event.bluetooth.a2dpsink.PLAYING_STATE_UPDATE', @@ -1340,7 +1504,8 @@ declare namespace commonEventManager { * Bluetooth.a2dp.audio.state.update. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_BLUETOOTH_A2DPSINK_AUDIO_STATE_UPDATE = 'usual.event.bluetooth.a2dpsink.AUDIO_STATE_UPDATE', @@ -1348,7 +1513,8 @@ declare namespace commonEventManager { * Nfc state change. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_NFC_ACTION_ADAPTER_STATE_CHANGED = 'usual.event.nfc.action.ADAPTER_STATE_CHANGED', @@ -1356,7 +1522,8 @@ declare namespace commonEventManager { * Nfc field on detected. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_NFC_ACTION_RF_FIELD_ON_DETECTED = 'usual.event.nfc.action.RF_FIELD_ON_DETECTED', @@ -1364,7 +1531,8 @@ declare namespace commonEventManager { * Nfc field off detected. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_NFC_ACTION_RF_FIELD_OFF_DETECTED = 'usual.event.nfc.action.RF_FIELD_OFF_DETECTED', @@ -1372,7 +1540,8 @@ declare namespace commonEventManager { * Sent when stop charging battery. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISCHARGING = 'usual.event.DISCHARGING', @@ -1380,7 +1549,8 @@ declare namespace commonEventManager { * Sent when start charging battery. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CHARGING = 'usual.event.CHARGING', @@ -1389,7 +1559,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CHARGE_TYPE_CHANGED = 'usual.event.CHARGE_TYPE_CHANGED', @@ -1397,7 +1568,8 @@ declare namespace commonEventManager { * Sent when device's idle mode changed * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED = 'usual.event.DEVICE_IDLE_MODE_CHANGED', @@ -1405,7 +1577,8 @@ declare namespace commonEventManager { * Sent when device's charge idle mode changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CHARGE_IDLE_MODE_CHANGED = 'usual.event.CHARGE_IDLE_MODE_CHANGED', @@ -1414,7 +1587,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DEVICE_IDLE_EXEMPTION_LIST_UPDATED = 'usual.event.DEVICE_IDLE_EXEMPTION_LIST_UPDATED', @@ -1422,7 +1596,8 @@ declare namespace commonEventManager { * Sent when device's power save mode changed * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_POWER_SAVE_MODE_CHANGED = 'usual.event.POWER_SAVE_MODE_CHANGED', @@ -1431,7 +1606,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_ADDED = 'usual.event.USER_ADDED', @@ -1440,7 +1616,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_REMOVED = 'usual.event.USER_REMOVED', @@ -1448,7 +1625,8 @@ declare namespace commonEventManager { * Sent when ability is added. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_ABILITY_ADDED = 'common.event.ABILITY_ADDED', @@ -1456,7 +1634,8 @@ declare namespace commonEventManager { * Sent when ability is removed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_ABILITY_REMOVED = 'common.event.ABILITY_REMOVED', @@ -1464,7 +1643,8 @@ declare namespace commonEventManager { * Sent when ability is updated. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_ABILITY_UPDATED = 'common.event.ABILITY_UPDATED', @@ -1472,7 +1652,8 @@ declare namespace commonEventManager { * Gps mode state changed. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_LOCATION_MODE_STATE_CHANGED = 'usual.event.location.MODE_STATE_CHANGED', @@ -1481,7 +1662,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_SLEEP = 'common.event.IVI_SLEEP', @@ -1490,7 +1672,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_PAUSE = 'common.event.IVI_PAUSE', @@ -1499,7 +1682,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_STANDBY = 'common.event.IVI_STANDBY', @@ -1508,7 +1692,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_LASTMODE_SAVE = 'common.event.IVI_LASTMODE_SAVE', @@ -1517,7 +1702,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_VOLTAGE_ABNORMAL = 'common.event.IVI_VOLTAGE_ABNORMAL', @@ -1527,7 +1713,8 @@ declare namespace commonEventManager { * please use COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_HIGH_TEMPERATURE = 'common.event.IVI_HIGH_TEMPERATURE', @@ -1537,7 +1724,8 @@ declare namespace commonEventManager { * please use COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_EXTREME_TEMPERATURE = 'common.event.IVI_EXTREME_TEMPERATURE', @@ -1546,7 +1734,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_TEMPERATURE_ABNORMAL = 'common.event.IVI_TEMPERATURE_ABNORMAL', @@ -1555,7 +1744,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_VOLTAGE_RECOVERY = 'common.event.IVI_VOLTAGE_RECOVERY', @@ -1564,7 +1754,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_TEMPERATURE_RECOVERY = 'common.event.IVI_TEMPERATURE_RECOVERY', @@ -1573,7 +1764,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_IVI_ACTIVE = 'common.event.IVI_ACTIVE', @@ -1582,7 +1774,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USB_STATE = 'usual.event.hardware.usb.action.USB_STATE', @@ -1591,7 +1784,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USB_PORT_CHANGED = 'usual.event.hardware.usb.action.USB_PORT_CHANGED', @@ -1600,7 +1794,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USB_DEVICE_ATTACHED = 'usual.event.hardware.usb.action.USB_DEVICE_ATTACHED', @@ -1609,7 +1804,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USB_DEVICE_DETACHED = 'usual.event.hardware.usb.action.USB_DEVICE_DETACHED', @@ -1618,7 +1814,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USB_ACCESSORY_ATTACHED = 'usual.event.hardware.usb.action.USB_ACCESSORY_ATTACHED', @@ -1627,7 +1824,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USB_ACCESSORY_DETACHED = 'usual.event.hardware.usb.action.USB_ACCESSORY_DETACHED', @@ -1636,7 +1834,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISK_REMOVED = 'usual.event.data.DISK_REMOVED', @@ -1645,7 +1844,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISK_UNMOUNTED = 'usual.event.data.DISK_UNMOUNTED', @@ -1654,7 +1854,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISK_MOUNTED = 'usual.event.data.DISK_MOUNTED', @@ -1663,7 +1864,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISK_BAD_REMOVAL = 'usual.event.data.DISK_BAD_REMOVAL', @@ -1672,7 +1874,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISK_UNMOUNTABLE = 'usual.event.data.DISK_UNMOUNTABLE', @@ -1681,7 +1884,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DISK_EJECT = 'usual.event.data.DISK_EJECT', @@ -1691,7 +1895,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VOLUME_REMOVED = 'usual.event.data.VOLUME_REMOVED', @@ -1701,7 +1906,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VOLUME_UNMOUNTED = 'usual.event.data.VOLUME_UNMOUNTED', @@ -1711,7 +1917,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VOLUME_MOUNTED = 'usual.event.data.VOLUME_MOUNTED', @@ -1721,7 +1928,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VOLUME_BAD_REMOVAL = 'usual.event.data.VOLUME_BAD_REMOVAL', @@ -1731,7 +1939,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VOLUME_EJECT = 'usual.event.data.VOLUME_EJECT', @@ -1740,7 +1949,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED = 'usual.event.data.VISIBLE_ACCOUNTS_UPDATED', @@ -1750,7 +1960,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * This API can be called only by system applications. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_ACCOUNT_DELETED = 'usual.event.data.ACCOUNT_DELETED', @@ -1759,7 +1970,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_FOUNDATION_READY = 'common.event.FOUNDATION_READY', @@ -1768,7 +1980,8 @@ declare namespace commonEventManager { * Users can register this event to listen to the change of the airplane mode status of the device. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_AIRPLANE_MODE_CHANGED = 'usual.event.AIRPLANE_MODE', @@ -1783,7 +1996,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SPLIT_SCREEN = 'common.event.SPLIT_SCREEN', @@ -1793,7 +2007,8 @@ declare namespace commonEventManager { * This API can be called only by system applications. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SLOT_CHANGE = 'usual.event.SLOT_CHANGE', @@ -1802,7 +2017,8 @@ declare namespace commonEventManager { * This common event can be triggered only by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SPN_INFO_CHANGED = 'usual.event.SPN_INFO_CHANGED', @@ -1811,7 +2027,8 @@ declare namespace commonEventManager { * This common event can be triggered only by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_QUICK_FIX_APPLY_RESULT = 'usual.event.QUICK_FIX_APPLY_RESULT', @@ -1820,7 +2037,8 @@ declare namespace commonEventManager { * This common event can be triggered only by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_QUICK_FIX_REVOKE_RESULT = 'usual.event.QUICK_FIX_REVOKE_RESULT', @@ -1829,7 +2047,8 @@ declare namespace commonEventManager { * This common event can be triggered only by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_USER_INFO_UPDATED = 'usual.event.USER_INFO_UPDATED', @@ -1838,7 +2057,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_HTTP_PROXY_CHANGE = 'usual.event.HTTP_PROXY_CHANGE', @@ -1847,7 +2067,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SIM_STATE_CHANGED = 'usual.event.SIM_STATE_CHANGED', @@ -1858,7 +2079,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SMS_RECEIVE_COMPLETED = 'usual.event.SMS_RECEIVE_COMPLETED', @@ -1868,7 +2090,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SMS_EMERGENCY_CB_RECEIVE_COMPLETED = 'usual.event.SMS_EMERGENCY_CB_RECEIVE_COMPLETED', @@ -1878,7 +2101,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SMS_CB_RECEIVE_COMPLETED = 'usual.event.SMS_CB_RECEIVE_COMPLETED', @@ -1890,7 +2114,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_STK_COMMAND = 'usual.event.STK_COMMAND', @@ -1902,7 +2127,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_STK_SESSION_END = 'usual.event.STK_SESSION_END', @@ -1914,7 +2140,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_STK_CARD_STATE_CHANGED = 'usual.event.STK_CARD_STATE_CHANGED', @@ -1926,7 +2153,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_STK_ALPHA_IDENTIFIER = 'usual.event.STK_ALPHA_IDENTIFIER', @@ -1936,7 +2164,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SMS_WAPPUSH_RECEIVE_COMPLETED = 'usual.event.SMS_WAPPUSH_RECEIVE_COMPLETED', @@ -1946,7 +2175,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_OPERATOR_CONFIG_CHANGED = 'usual.event.OPERATOR_CONFIG_CHANGED', @@ -1956,7 +2186,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SIM_CARD_DEFAULT_SMS_SUBSCRIPTION_CHANGED = 'usual.event.SIM.DEFAULT_SMS_SUBSCRIPTION_CHANGED', @@ -1966,7 +2197,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SIM_CARD_DEFAULT_DATA_SUBSCRIPTION_CHANGED = 'usual.event.SIM.DEFAULT_DATA_SUBSCRIPTION_CHANGED', @@ -1976,7 +2208,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SIM_CARD_DEFAULT_MAIN_SUBSCRIPTION_CHANGED = 'usual.event.SIM.DEFAULT_MAIN_SUBSCRIPTION_CHANGED', @@ -1986,7 +2219,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SET_PRIMARY_SLOT_STATUS = 'usual.event.SET_PRIMARY_SLOT_STATUS', @@ -1996,7 +2230,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PRIMARY_SLOT_ROAMING = 'usual.event.PRIMARY_SLOT_ROAMING', @@ -2006,7 +2241,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SIM_CARD_DEFAULT_VOICE_SUBSCRIPTION_CHANGED = 'usual.event.SIM.DEFAULT_VOICE_SUBSCRIPTION_CHANGED', @@ -2017,7 +2253,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CALL_STATE_CHANGED = 'usual.event.CALL_STATE_CHANGED', @@ -2027,7 +2264,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CELLULAR_DATA_STATE_CHANGED = 'usual.event.CELLULAR_DATA_STATE_CHANGED', @@ -2036,7 +2274,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_NETWORK_STATE_CHANGED = 'usual.event.NETWORK_STATE_CHANGED', @@ -2045,7 +2284,8 @@ declare namespace commonEventManager { * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SIGNAL_INFO_CHANGED = 'usual.event.SIGNAL_INFO_CHANGED', @@ -2057,7 +2297,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_INCOMING_CALL_MISSED = 'usual.event.INCOMING_CALL_MISSED', @@ -2067,7 +2308,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_RADIO_STATE_CHANGE = 'usual.event.RADIO_STATE_CHANGE', @@ -2077,7 +2319,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DOMAIN_ACCOUNT_STATUS_CHANGED = 'usual.event.DOMAIN_ACCOUNT_STATUS_CHANGED', @@ -2092,7 +2335,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SCREEN_UNLOCKED = 'usual.event.SCREEN_UNLOCKED', @@ -2107,7 +2351,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SCREEN_LOCKED = 'usual.event.SCREEN_LOCKED', @@ -2124,7 +2369,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_CONNECTIVITY_CHANGE = 'usual.event.CONNECTIVITY_CHANGE', @@ -2134,7 +2380,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_SPECIAL_CODE = 'common.event.SPECIAL_CODE', @@ -2144,7 +2391,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_AUDIO_QUALITY_CHANGE = 'usual.event.AUDIO_QUALITY_CHANGE', @@ -2154,7 +2402,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PRIVACY_STATE_CHANGED = 'usual.event.PRIVACY_STATE_CHANGED', @@ -2164,7 +2413,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_PACKAGE_INSTALLATION_STARTED = 'usual.event.PACKAGE_INSTALLATION_STARTED', @@ -2174,7 +2424,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DYNAMIC_ICON_CHANGED = 'usual.event.DYNAMIC_ICON_CHANGED', @@ -2184,7 +2435,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MINORSMODE_ON = 'usual.event.MINORSMODE_ON', @@ -2194,7 +2446,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MINORSMODE_OFF = 'usual.event.MINORSMODE_OFF', @@ -2206,9 +2459,10 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ - COMMON_EVENT_BUNDLE_RESOURCES_CHANGED = "usual.event.BUNDLE_RESOURCES_CHANGED", + COMMON_EVENT_BUNDLE_RESOURCES_CHANGED = 'usual.event.BUNDLE_RESOURCES_CHANGED', /** * This common event means that datashare is ready. @@ -2216,7 +2470,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_DATA_SHARE_READY = 'usual.event.DATA_SHARE_READY', @@ -2226,7 +2481,8 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_VPN_CONNECTION_STATUS_CHANGED = 'usual.event.VPN_CONNECTION_STATUS_CHANGED', @@ -2238,16 +2494,18 @@ declare namespace commonEventManager { * * @syscap SystemCapability.Notification.CommonEvent * @systemapi - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_RESTORE_START = 'usual.event.RESTORE_START', - + /** * Indicates that the managed browser policy is changed. * This is a protected common event that can only be sent by system. * * @syscap SystemCapability.Notification.CommonEvent - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMON_EVENT_MANAGED_BROWSER_POLICY_CHANGED = 'usual.event.MANAGED_BROWSER_POLICY_CHANGED', } @@ -2264,7 +2522,8 @@ declare namespace commonEventManager { * @typedef { _CommonEventData } CommonEventData * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type CommonEventData = _CommonEventData; @@ -2280,7 +2539,8 @@ declare namespace commonEventManager { * @typedef { _CommonEventSubscriber } CommonEventSubscriber * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type CommonEventSubscriber = _CommonEventSubscriber; @@ -2296,7 +2556,8 @@ declare namespace commonEventManager { * @typedef { _CommonEventSubscribeInfo } CommonEventSubscribeInfo * @syscap SystemCapability.Notification.CommonEvent * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type CommonEventSubscribeInfo = _CommonEventSubscribeInfo; @@ -2320,7 +2581,8 @@ declare namespace commonEventManager { * @syscap SystemCapability.Notification.CommonEvent * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type CommonEventPublishData = _CommonEventPublishData; } diff --git a/api/@ohos.configPolicy.d.ts b/api/@ohos.configPolicy.d.ts index 30a15b2ab8421e2a160ed76c3d283e9a151ba42d..2bffaa511e3ed6ecf2ec479ed921aab40a669bd2 100644 --- a/api/@ohos.configPolicy.d.ts +++ b/api/@ohos.configPolicy.d.ts @@ -16,6 +16,7 @@ /** * @file * @kit BasicServicesKit + * @arkts 1.1&1.2 */ import { AsyncCallback } from './@ohos.base'; @@ -26,7 +27,7 @@ import { AsyncCallback } from './@ohos.base'; * @namespace configPolicy * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} */ declare namespace configPolicy { /** @@ -35,7 +36,7 @@ declare namespace configPolicy { * @enum { number } * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ export enum FollowXMode { /** @@ -43,7 +44,7 @@ declare namespace configPolicy { * * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ DEFAULT = 0, @@ -52,7 +53,7 @@ declare namespace configPolicy { * * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ NO_RULE_FOLLOWED = 1, @@ -61,7 +62,7 @@ declare namespace configPolicy { * * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ SIM_DEFAULT = 10, @@ -70,7 +71,7 @@ declare namespace configPolicy { * * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ SIM_1 = 11, @@ -79,7 +80,7 @@ declare namespace configPolicy { * * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ SIM_2 = 12, @@ -89,7 +90,7 @@ declare namespace configPolicy { * * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ USER_DEFINED = 100 } @@ -103,9 +104,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} */ - function getOneCfgFile(relPath: string, callback: AsyncCallback); + function getOneCfgFile(relPath: string, callback: AsyncCallback): void; /** * Gets the file from the highest priority config path containing the given file name in follow mode. @@ -117,9 +118,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ - function getOneCfgFile(relPath: string, followMode: FollowXMode, callback: AsyncCallback); + function getOneCfgFile(relPath: string, followMode: FollowXMode, callback: AsyncCallback): void; /** * Gets the file from the highest priority config path containing the given file name in follow mode. @@ -132,9 +133,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ - function getOneCfgFile(relPath: string, followMode: FollowXMode, extra: string, callback: AsyncCallback); + function getOneCfgFile(relPath: string, followMode: FollowXMode, extra: string, callback: AsyncCallback): void; /** * Gets the file from the highest priority config path containing the given file name. @@ -145,7 +146,7 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} */ function getOneCfgFile(relPath: string): Promise; @@ -160,7 +161,7 @@ declare namespace configPolicy { *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ function getOneCfgFile(relPath: string, followMode: FollowXMode, extra?: string): Promise; @@ -175,7 +176,7 @@ declare namespace configPolicy { *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ function getOneCfgFileSync(relPath: string, followMode?: FollowXMode, extra?: string): string; @@ -188,9 +189,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} */ - function getCfgFiles(relPath: string, callback: AsyncCallback>); + function getCfgFiles(relPath: string, callback: AsyncCallback>): void; /** * Gets the config files in device architecture in follow mode, ordered by priority from low to high. @@ -202,9 +203,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ - function getCfgFiles(relPath: string, followMode: FollowXMode, callback: AsyncCallback>); + function getCfgFiles(relPath: string, followMode: FollowXMode, callback: AsyncCallback>): void; /** * Gets the config files in device architecture in follow mode, ordered by priority from low to high. @@ -217,9 +218,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ - function getCfgFiles(relPath: string, followMode: FollowXMode, extra: string, callback: AsyncCallback>); + function getCfgFiles(relPath: string, followMode: FollowXMode, extra: string, callback: AsyncCallback>): void; /** * Gets the config files in device architecture, ordered by priority from low to high. @@ -230,7 +231,7 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} */ function getCfgFiles(relPath: string): Promise>; @@ -245,7 +246,7 @@ declare namespace configPolicy { *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ function getCfgFiles(relPath: string, followMode: FollowXMode, extra?: string): Promise>; @@ -260,7 +261,7 @@ declare namespace configPolicy { *
2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} */ function getCfgFilesSync(relPath: string, followMode?: FollowXMode, extra?: string): Array; @@ -272,9 +273,9 @@ declare namespace configPolicy { *
2.Incorrect parameter types. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} */ - function getCfgDirList(callback: AsyncCallback>); + function getCfgDirList(callback: AsyncCallback>): void; /** * Gets the config directory in the device architecture, ordered by priority from low to high. @@ -291,7 +292,7 @@ declare namespace configPolicy { * @returns { Promise> } the promise returns the list of configuration level directories. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} */ function getCfgDirList(): Promise>; @@ -310,7 +311,7 @@ declare namespace configPolicy { * @returns { Array } the list of configuration level directories. * @syscap SystemCapability.Customization.ConfigPolicy * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} */ function getCfgDirListSync(): Array; } diff --git a/api/@ohos.curves.d.ts b/api/@ohos.curves.d.ts index 41e20cddae0bc98e90508deac2fce6b63619a0f5..54fd46f76534b07deee599d32ea5a303157ef889 100644 --- a/api/@ohos.curves.d.ts +++ b/api/@ohos.curves.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * 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 @@ -40,7 +40,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace curves { /** @@ -65,7 +66,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum Curve { /** @@ -87,7 +89,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Linear, /** @@ -112,7 +115,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Ease, /** @@ -134,7 +138,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EaseIn, /** @@ -156,7 +161,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EaseOut, /** @@ -178,7 +184,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EaseInOut, /** @@ -200,7 +207,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FastOutSlowIn, /** @@ -222,7 +230,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LinearOutSlowIn, /** @@ -244,7 +253,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FastOutLinearIn, /** @@ -266,7 +276,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ExtremeDeceleration, /** @@ -288,7 +299,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Sharp, /** @@ -310,7 +322,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Rhythm, /** @@ -332,7 +345,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Smooth, /** @@ -354,7 +368,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ Friction, } @@ -381,7 +396,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ICurve { /** @@ -412,7 +428,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interpolate(fraction: number): number; } @@ -442,7 +459,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function initCurve(curve?: Curve): ICurve; @@ -486,7 +504,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function stepsCurve(count: number, end: boolean): ICurve; @@ -507,7 +526,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function customCurve(interpolate: (fraction: number) => number): ICurve; @@ -563,7 +583,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function cubicBezierCurve(x1: number, y1: number, x2: number, y2: number): ICurve; @@ -618,7 +639,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function springCurve(velocity: number, mass: number, stiffness: number, damping: number): ICurve; @@ -679,7 +701,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function springMotion(response?: number, dampingFraction?: number, overlapDuration?: number): ICurve; @@ -724,7 +747,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function responsiveSpringMotion(response?: number, dampingFraction?: number, overlapDuration?: number): ICurve; @@ -763,7 +787,8 @@ declare namespace curves { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function interpolatingSpring(velocity: number, mass: number, stiffness: number, damping: number): ICurve; } diff --git a/api/@ohos.customization.customConfig.d.ts b/api/@ohos.customization.customConfig.d.ts index 2717e051140dbc2b2b91b469c40262e380d3d857..0dfc711b0c4124d7305b9db15f95ff0bb55d7210 100644 --- a/api/@ohos.customization.customConfig.d.ts +++ b/api/@ohos.customization.customConfig.d.ts @@ -16,6 +16,7 @@ /** * @file * @kit BasicServicesKit + * @arkts 1.1&1.2 */ /** @@ -31,7 +32,7 @@ * @namespace customConfig * @syscap SystemCapability.Customization.CustomConfig * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} */ declare namespace customConfig { @@ -48,7 +49,7 @@ declare namespace customConfig { * @returns { string } the channelId or empty if not exist. * @syscap SystemCapability.Customization.CustomConfig * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} */ function getChannelId(): string; diff --git a/api/@ohos.data.DataShareResultSet.d.ts b/api/@ohos.data.DataShareResultSet.d.ts index 5c7ad361774357e5682ed7dab232e43b40de86a1..e49354024c80b0a7200d9c472687b6ac86c9eba4 100644 --- a/api/@ohos.data.DataShareResultSet.d.ts +++ b/api/@ohos.data.DataShareResultSet.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022 Huawei Device Co., Ltd. + * Copyright (c) 2022-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 @@ -87,7 +87,8 @@ export enum DataType { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export default interface DataShareResultSet { /** @@ -122,7 +123,8 @@ export default interface DataShareResultSet { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rowCount: number; @@ -146,7 +148,8 @@ export default interface DataShareResultSet { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ goToFirstRow(): boolean; @@ -236,7 +239,8 @@ export default interface DataShareResultSet { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getString(columnIndex: number): string; @@ -275,7 +279,8 @@ export default interface DataShareResultSet { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; @@ -288,7 +293,8 @@ export default interface DataShareResultSet { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getColumnIndex(columnName: string): number; diff --git a/api/@ohos.data.ValuesBucket.d.ts b/api/@ohos.data.ValuesBucket.d.ts index 26bf99827e656d0b53def3a6dcb16a336a86e269..b93185c96e3210cae83317f7bca3999306a4ec2f 100644 --- a/api/@ohos.data.ValuesBucket.d.ts +++ b/api/@ohos.data.ValuesBucket.d.ts @@ -16,6 +16,7 @@ /** * @file * @kit ArkData + * @arkts 1.1&1.2 */ /** @@ -32,7 +33,7 @@ * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @stagemodelonly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ export type ValueType = number | string | boolean; @@ -42,6 +43,6 @@ export type ValueType = number | string | boolean; * @typedef { Record } * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} */ export type ValuesBucket = Record; diff --git a/api/@ohos.data.dataShare.d.ts b/api/@ohos.data.dataShare.d.ts index 1270c3e03a5d54ce9705a99dfecd66d0f88d9b54..cbb219507d781b5b98c2c8d37f28706abe634f33 100644 --- a/api/@ohos.data.dataShare.d.ts +++ b/api/@ohos.data.dataShare.d.ts @@ -31,7 +31,8 @@ import { ValuesBucket } from './@ohos.data.ValuesBucket'; * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace dataShare { /** @@ -41,7 +42,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DataShareHelperOptions { /** @@ -53,7 +55,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isProxy?: boolean; /** @@ -81,7 +84,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function createDataShareHelper(context: Context, uri: string, callback: AsyncCallback): void; /** @@ -97,7 +101,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function createDataShareHelper( context: Context, @@ -133,7 +138,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function createDataShareHelper( context: Context, @@ -459,7 +465,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ChangeType { /** @@ -468,7 +475,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INSERT = 0, @@ -478,7 +486,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DELETE, /** @@ -487,7 +496,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UPDATE } @@ -498,7 +508,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum SubscriptionType { /** @@ -507,7 +518,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SUBSCRIPTION_TYPE_EXACT_URI = 0, } @@ -519,7 +531,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ChangeInfo { /** @@ -529,7 +542,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ChangeType; @@ -540,7 +554,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; /** @@ -550,7 +565,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ values: Array; } @@ -562,7 +578,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DataShareHelper { /** @@ -589,7 +606,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'dataChange', uri: string, callback: AsyncCallback): void; @@ -617,7 +635,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'dataChange', uri: string, callback?: AsyncCallback): void; /** @@ -634,7 +653,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ on(event: 'dataChange', type:SubscriptionType, uri: string, callback: AsyncCallback): void; @@ -652,7 +672,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ off(event: 'dataChange', type:SubscriptionType, uri: string, callback?: AsyncCallback): void; @@ -1203,7 +1224,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ query( uri: string, @@ -1244,7 +1266,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ query( uri: string, @@ -1282,7 +1305,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ update( uri: string, @@ -1321,7 +1345,8 @@ declare namespace dataShare { * @syscap SystemCapability.DistributedDataManager.DataShare.Consumer * @systemapi * @stagemodelonly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket): Promise; diff --git a/api/@ohos.data.dataSharePredicates.d.ts b/api/@ohos.data.dataSharePredicates.d.ts index 19fb6d0ee11f8ad5acd7025f3a093c002187141b..1c681b68073f0014c6613fa4ae1eeb57b5d2a000 100644 --- a/api/@ohos.data.dataSharePredicates.d.ts +++ b/api/@ohos.data.dataSharePredicates.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2023 Huawei Device Co., Ltd. + * Copyright (c) 2023-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 @@ -35,7 +35,8 @@ import { ValueType } from './@ohos.data.ValuesBucket'; * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace dataSharePredicates { /** @@ -51,7 +52,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ class DataSharePredicates { /** @@ -77,7 +79,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ equalTo(field: string, value: ValueType): DataSharePredicates; @@ -92,7 +95,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ notEqualTo(field: string, value: ValueType): DataSharePredicates; @@ -104,7 +108,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ beginWrap(): DataSharePredicates; @@ -117,7 +122,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ endWrap(): DataSharePredicates; @@ -129,7 +135,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ or(): DataSharePredicates; @@ -150,7 +157,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ and(): DataSharePredicates; @@ -165,7 +173,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ contains(field: string, value: string): DataSharePredicates; @@ -237,7 +246,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ like(field: string, value: string): DataSharePredicates; @@ -310,7 +320,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ greaterThan(field: string, value: ValueType): DataSharePredicates; @@ -323,7 +334,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ lessThan(field: string, value: ValueType): DataSharePredicates; @@ -336,7 +348,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ greaterThanOrEqualTo(field: string, value: ValueType): DataSharePredicates; @@ -372,7 +385,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ orderByAsc(field: string): DataSharePredicates; @@ -395,7 +409,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ orderByDesc(field: string): DataSharePredicates; @@ -429,7 +444,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ limit(total: number, offset: number): DataSharePredicates; @@ -441,7 +457,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ groupBy(fields: Array): DataSharePredicates; @@ -479,7 +496,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ in(field: string, value: Array): DataSharePredicates; @@ -493,7 +511,8 @@ declare namespace dataSharePredicates { * @syscap SystemCapability.DistributedDataManager.DataShare.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ notIn(field: string, value: Array): DataSharePredicates; diff --git a/api/@ohos.data.distributedKVStore.d.ets b/api/@ohos.data.distributedKVStore.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..6c459e422776881d97fdea7958d88d23e9d8a4d3 --- /dev/null +++ b/api/@ohos.data.distributedKVStore.d.ets @@ -0,0 +1,3150 @@ +/* + * 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 ArkData + */ + +import { AsyncCallback, Callback } from './@ohos.base'; +import { ValuesBucket } from './@ohos.data.ValuesBucket'; +import dataSharePredicates from './@ohos.data.dataSharePredicates'; +import BaseContext from './application/BaseContext'; + +/** + * Provider interfaces to create a {@link KVManager} instance. + * + * @namespace distributedKVStore + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ +declare namespace distributedKVStore { + /** + * Provides configuration information to create a {@link KVManager} instance, + * which includes the caller's package name and ability or hap context. + * + * @interface KVManagerConfig + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface KVManagerConfig { + /** + * Indicates the bundleName + * + * @type { string } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + bundleName: string; + + /** + * Indicates the ability or hap context + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * if swap the area, you should close all the KV store and use the new Context to create the KVManager + * @since 9 + */ + /** + * Indicates the ability or hap context + * + * @type { BaseContext } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * if swap the area, you should close all the KV store and use the new BaseContext to create the KVManager + * @since 10 + */ + context: BaseContext; + } + + /** + * KVStore constants + * + * @interface Constants + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface Constants { + /** + * Max key length is 1024. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + readonly MAX_KEY_LENGTH: number; + + /** + * Max value length is 4194303. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + readonly MAX_VALUE_LENGTH: number; + + /** + * Max device coordinate key length is 896. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + readonly MAX_KEY_LENGTH_DEVICE: number; + + /** + * Max store id length is 128. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + readonly MAX_STORE_ID_LENGTH: number; + + /** + * Max query length is 512000. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + readonly MAX_QUERY_LENGTH: number; + + /** + * Max batch operation size is 128. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + readonly MAX_BATCH_SIZE: number; + } + + /** + * Indicates the {@code ValueType}. + *

{@code ValueType} is obtained based on the value. + * + * @enum { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export enum ValueType { + /** + * Indicates that the value type is string. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + STRING, + + /** + * Indicates that the value type is int. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + INTEGER, + + /** + * Indicates that the value type is float. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + FLOAT, + + /** + * Indicates that the value type is byte array. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + BYTE_ARRAY, + + /** + * Indicates that the value type is boolean. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + BOOLEAN, + + /** + * Indicates that the value type is double. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + DOUBLE + } + + /** + * Obtains {@code Value} objects stored in a {@link SingleKVStore} or {@link DeviceKVStore} database. + * + * @interface Value + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface Value { + /** + * Indicates the value type + * + * @type { ValueType } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + * @see ValueType + */ + type: ValueType; + + /** + * Indicates the value + * + * @type { Uint8Array | string | number | boolean } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + value: Uint8Array | string | number | boolean; + } + + /** + * Provides key-value pairs stored in the distributedKVStore. + * + * @interface Entry + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface Entry { + /** + * Indicates the key + * + * @type { string } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + key: string; + + /** + * Indicates the value + * + * @type { Value } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + value: Value; + } + + /** + * Receive notifications of all data changes, including data insertion, update, and deletion. + *

If you have subscribed to {@code SingleKVStore} or {@code DeviceKVStore}, you will receive + * data change notifications and obtain the changed data from the parameters in callback methods + * upon data insertion, update or deletion. + * + * @interface ChangeNotification + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface ChangeNotification { + /** + * Indicates data insertion records. + * + * @type { Entry[] } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + insertEntries: Entry[]; + + /** + * Indicates data update records. + * + * @type { Entry[] } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + updateEntries: Entry[]; + + /** + * Indicates data deletion records. + * + * @type { Entry[] } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deleteEntries: Entry[]; + + /** + * Indicates the device id which brings the data change. + * + * @type { string } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deviceId: string; + } + + /** + * Indicates the database synchronization mode. + * + * @enum { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export enum SyncMode { + /** + * Indicates that data is only pulled from the remote end. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + PULL_ONLY, + + /** + * Indicates that data is only pushed from the local end. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + PUSH_ONLY, + + /** + * Indicates that data is pushed from the local end, and then pulled from the remote end. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + PUSH_PULL + } + + /** + * Describes the subscription type. + * + * @enum { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export enum SubscribeType { + /** + * Subscription to local data changes + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + SUBSCRIBE_TYPE_LOCAL, + + /** + * Subscription to remote data changes + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + SUBSCRIBE_TYPE_REMOTE, + + /** + * Subscription to both local and remote data changes + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + SUBSCRIBE_TYPE_ALL + } + + /** + * Describes the KVStore type. + * + * @enum { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export enum KVStoreType { + /** + * Device-collaboration database, as specified by {@code DeviceKVStore} + * + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + DEVICE_COLLABORATION, + + /** + * Single-version database, as specified by {@code SingleKVStore} + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + SINGLE_VERSION + } + + /** + * Describes the KVStore security level. + * + * @enum { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export enum SecurityLevel { + /** + * S1: means the db is in the low security level + * There are some low impact when the data is leaked. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + S1, + + /** + * S2: means the db is in the middle security level + * There are some major impact when the data is leaked. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + S2, + + /** + * S3: means the db is in the high security level + * There are some severity impact when the data is leaked. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + S3, + + /** + * S4: means the db is in the critical security level + * There are some critical impact when the data is leaked. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + S4 + } + + /** + * Provides configuration options to create a {@code SingleKVStore} or {@code DeviceKVStore}. + * + * @interface Options + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface Options { + /** + * Indicates whether to create a database when the database file does not exist + * + * @type { ?boolean } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + createIfMissing?: boolean; + + /** + * Indicates whether database files to be encrypted + * + * @type { ?boolean } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + encrypt?: boolean; + + /** + * Indicates whether to back up database files + * + * @type { ?boolean } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + backup?: boolean; + + /** + * Indicates whether database files are automatically synchronized + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @type { ?boolean } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + autoSync?: boolean; + + /** + * Indicates the database type + * + * @type { ?KVStoreType } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + kvStoreType?: KVStoreType; + + /** + * Indicates the database security level + * + * @type { SecurityLevel } + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + securityLevel: SecurityLevel; + + /** + * Indicates the database schema + * + * @type { ?Schema } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + schema?: Schema; + } + + /** + * Represents the database schema. + * You can set the schema object in options when create or open the database. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + export class Schema { + /** + * A constructor used to create a Schema instance. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + constructor(); + + /** + * Indicates the root json object. + * + * @type { FieldNode } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + root: FieldNode; + + /** + * Indicates the string array of json. + * + * @type { Array } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + indexes: Array; + + /** + * Indicates the mode of schema. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + mode: number; + + /** + * Indicates the skip size of schema. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + skip: number; + } + + /** + * Represents a node of a {@link Schema} instance. + *

With a {@link Schema} instance, you can define the value fields which stored in the database. + *

A FieldNode of the {@link Schema} instance is either a leaf or a non-leaf node. + *

The leaf node must have a value; the non-leaf node must have a child {@code FieldNode}. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + export class FieldNode { + /** + * A constructor used to create a FieldNode instance with the specified field. + * name Indicates the field node name. + * + * @param { string } name - It can not be empty. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + constructor(name: string); + + /** + * Adds a child node to this {@code FieldNode}. + *

Add a child node to makes this node a non-leaf node and field value will be ignored if it has a child node. + * + * @param { FieldNode } child - The field node to append. + * @returns { boolean } Returns true if the child node is successfully added to this {@code FieldNode} and false otherwise. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + appendChild(child: FieldNode): boolean; + + /** + * Indicates the default value of field node. + * + * @type { string } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + // default: string; // TODO: add this field + + /** + * Indicates the nullable of database field. + * + * @type { boolean } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + nullable: boolean; + + /** + * Indicates the type of value. + * + * @type { number } + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + type: number; + } + + /** + * Provides methods to operate the result set of the {@code SingleKVStore} or {@code DeviceKVStore} database. + *

The result set is created by using the {@code getResultSet} method in the {@code SingleKVStore} or + * {@code DeviceKVStore} class. This interface also provides methods to move the data read + * position in the result set. + * + * @interface KVStoreResultSet + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface KVStoreResultSet { + /** + * Obtains the number of lines in a result set. + * + * @returns { number } Returns the number of lines. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getCount(): number; + + /** + * Obtains the current read position in a result set. + * + * @returns { number } Returns the current read position. The read position starts with 0. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getPosition(): number; + + /** + * Moves the read position to the first line. + *

If the result set is empty, false is returned. + * + * @returns { boolean } Returns true if the operation succeeds; return false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + moveToFirst(): boolean; + + /** + * Moves the read position to the last line. + *

If the result set is empty, false is returned. + * + * @returns { boolean } Returns true if the operation succeeds; return false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + moveToLast(): boolean; + + /** + * Moves the read position to the next line. + *

If the result set is empty or the data in the last line is being read, false is returned. + * + * @returns { boolean } Returns true if the operation succeeds; return false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + moveToNext(): boolean; + + /** + * Moves the read position to the previous line. + *

If the result set is empty or the data in the first line is being read, false is returned. + * + * @returns { boolean } Returns true if the operation succeeds; return false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + moveToPrevious(): boolean; + + /** + * Moves the read position by a relative offset to the current position. + * + * @param { number } offset - Indicates the relative offset to the current position. A negative offset indicates moving + * backwards, and a positive offset indicates moving forwards. For example, if the current position is entry 1 and + * this offset is 2, the destination position will be entry 3; if the current position is entry 3 and this offset is -2, + * the destination position will be entry 1. The valid final position after moving forwards starts with 0. If the + * final position is invalid, false will be returned. + * @returns { boolean } Returns true if the operation succeeds; return false otherwise. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + move(offset: number): boolean; + + /** + * Moves the read position from 0 to an absolute position. + * + * @param { number } position - Indicates the absolute position. + * @returns { boolean } Returns true if the operation succeeds; return false otherwise. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + moveToPosition(position: number): boolean; + + /** + * Checks whether the read position is the first line. + * + * @returns { boolean } Returns true if the read position is the first line; returns false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + isFirst(): boolean; + + /** + * Checks whether the read position is the last line. + * + * @returns { boolean } Returns true if the read position is the last line; returns false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + isLast(): boolean; + + /** + * Checks whether the read position is before the last line. + * + * @returns { boolean } Returns true if the read position is before the first line; returns false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + isBeforeFirst(): boolean; + + /** + * Checks whether the read position is after the last line. + * + * @returns { boolean } Returns true if the read position is after the last line; returns false otherwise. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + isAfterLast(): boolean; + + /** + * Obtains a key-value pair. + * + * @returns { Entry } Returns a key-value pair. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntry(): Entry; + } + + /** + * Represents a database query using predicates. + *

This class provides a constructor used to create a {@code Query} instance, which is used to query data + * matching specified conditions in the database. + *

This class also provides methods to add predicates to the {@code Query} instance. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export class Query { + /** + * A constructor used to create a Query instance. + * + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + constructor(); + + /** + * Resets this {@code Query} object. + * + * @returns { Query } Returns the reset {@code Query} object. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + reset(): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is equal to the specified long value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number | string | boolean } value - Indicates the value to be compared. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + equalTo(field: string, value: number | string | boolean): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is not equal to the specified int value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number | string | boolean } value - Indicates the value to be compared. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + notEqualTo(field: string, value: number | string | boolean): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is greater than or equal to the + * specified int value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number | string | boolean } value - Indicates the value to be compared. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + greaterThan(field: string, value: number | string | boolean): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is less than the specified int value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number | string } value - Indicates the value to be compared. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + lessThan(field: string, value: number | string): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is greater than or + * equal to the specified int value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number | string } value - Indicates the value to be compared. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + greaterThanOrEqualTo(field: string, value: number | string): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is less than or equal to the + * specified int value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number | string } value - Indicates the value to be compared. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + lessThanOrEqualTo(field: string, value: number | string): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is null. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + isNull(field: string): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is within the specified int value list. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number[] } valueList - Indicates the int value list. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + inNumber(field: string, valueList: number[]): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is within the specified string value list. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { string[] } valueList - Indicates the string value list. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + inString(field: string, valueList: string[]): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is not within the specified int value list. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { number[] } valueList - Indicates the int value list. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + notInNumber(field: string, valueList: number[]): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is not within the specified string value list. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { string[] } valueList - Indicates the string value list. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + notInString(field: string, valueList: string[]): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is similar to the specified string value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { string } value - Indicates the string value. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + like(field: string, value: string): Query; + + /** + * Constructs a {@code Query} object to query entries with the specified field whose value is not similar to the specified string value. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @param { string } value - Indicates the string value. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + unlike(field: string, value: string): Query; + + /** + * Constructs a {@code Query} object with the and condition. + *

Multiple predicates should be connected using the and or or condition. + * + * @returns { Query } Returns the {@coed Query} object. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + and(): Query; + + /** + * Constructs a {@code Query} object with the or condition. + *

Multiple predicates should be connected using the and or or condition. + * + * @returns { Query } Returns the {@coed Query} object. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + or(): Query; + + /** + * Constructs a {@code Query} object to sort the query results in ascending order. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + orderByAsc(field: string): Query; + + /** + * Constructs a {@code Query} object to sort the query results in descending order. + * + * @param { string } field - Indicates the field, which cannot contain ^. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + orderByDesc(field: string): Query; + + /** + * Constructs a {@code Query} object to specify the number of results and the start position. + * + * @param { number } total - Indicates the number of results. + * @param { number } offset - Indicates the start position. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + limit(total: number, offset: number): Query; + + /** + * Creates a {@code Query} condition with a specified field that is not null. + * + * @param { string } field - Indicates the specified field. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + isNotNull(field: string): Query; + + /** + * Creates a query condition group with a left bracket. + *

Multiple query conditions in an {@code Query} object can be grouped. The query conditions in a group can be used as a + * whole to combine with other query conditions. + * + * @returns { Query } Returns the {@coed Query} object. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + beginGroup(): Query; + + /** + * Creates a query condition group with a right bracket. + *

Multiple query conditions in an {@code Query} object can be grouped. The query conditions in a group can be used as a + * whole to combine with other query conditions. + * + * @returns { Query } Returns the {@coed Query} object. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + endGroup(): Query; + + /** + * Creates a query condition with a specified key prefix. + * + * @param { string } prefix - Indicates the specified key prefix. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + prefixKey(prefix: string): Query; + + /** + * Sets a specified index that will be preferentially used for query. + * + * @param { string } index - Indicates the index to set. + * @returns { Query } Returns the {@coed Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + setSuggestIndex(index: string): Query; + + /** + * Add device ID key prefix.Used by {@code DeviceKVStore}. + * + * @param { string } deviceId - Specify device id to query from, It can not be empty. + * @returns { Query } Returns the {@code Query} object with device ID prefix added. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deviceId(deviceId: string): Query; + + /** + * Get a String that represents this {@code Query}. + *

The String would be parsed to DB query format. + * The String length should be no longer than 500kb. + * + * @returns { string } String representing this {@code Query}. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getSqlLike(): string; + } + + /** + * Provides methods related to single-version distributed databases. + *

To create a {@code SingleKVStore} database, + * you can use the {@link data.distributed.common.KVManager#getKVStore​(Options, String)} method + * with {@code KVStoreType} set to {@code SINGLE_VERSION} for the input parameter {@code Options}. + * This database synchronizes data to other databases in time sequence. + * The {@code SingleKVStore} database does not support + * synchronous transactions, or data search using snapshots. + * + * @interface SingleKVStore + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface SingleKVStore { + /** + * Writes a key-value pair of the string type into the {@code SingleKVStore} database. + *

If you do not want to synchronize this key-value pair to other devices, set the write option in the local database. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. + * @param { AsyncCallback } callback - the callback of put. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Writes a key-value pair of the string type into the {@code SingleKVStore} database. + *

If you do not want to synchronize this key-value pair to other devices, set the write option in the local database. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. + * @param { AsyncCallback } callback - the callback of put. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + put(key: string, value: Uint8Array | string | number | boolean, callback: AsyncCallback): void; + + /** + * Writes a key-value pair of the string type into the {@code SingleKVStore} database. + *

If you do not want to synchronize this key-value pair to other devices, set the write option in the local database. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Writes a key-value pair of the string type into the {@code SingleKVStore} database. + *

If you do not want to synchronize this key-value pair to other devices, set the write option in the local database. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @param { Uint8Array | string | number | boolean } value - Indicates the value to be inserted. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + put(key: string, value: Uint8Array | string | number | boolean): Promise; + + /** + * Inserts key-value pairs into the {@code SingleKVStore} database in batches. + * + * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. + * @param { AsyncCallback } callback - the callback of putBatch. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Inserts key-value pairs into the {@code SingleKVStore} database in batches. + * + * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. + * @param { AsyncCallback } callback - the callback of putBatch. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + putBatch(entries: Entry[], callback: AsyncCallback): void; + + /** + * Inserts key-value pairs into the {@code SingleKVStore} database in batches. + * + * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Inserts key-value pairs into the {@code SingleKVStore} database in batches. + * + * @param { Entry[] } entries - Indicates the key-value pairs to be inserted in batches. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + putBatch(entries: Entry[]): Promise; + + /** + * Writes values of ValuesBucket type into the {@code SingleKVStore} database. + * + * @param { Array } value - Indicates the ValuesBucket array to be inserted. + * @param { AsyncCallback } callback - the callback of putBatch. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Writes values of ValuesBucket type into the {@code SingleKVStore} database. + * + * @param { Array } value - Indicates the ValuesBucket array to be inserted. + * @param { AsyncCallback } callback - the callback of putBatch. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @systemapi + * @StageModelOnly + * @since 10 + */ + putBatch(value: Array, callback: AsyncCallback): void; + + /** + * Writes values of ValuesBucket type into the {@code SingleKVStore} database. + * + * @param { Array } value - Indicates the ValuesBucket array to be inserted. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Writes values of ValuesBucket type into the {@code SingleKVStore} database. + * + * @param { Array } value - Indicates the ValuesBucket array to be inserted. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @systemapi + * @StageModelOnly + * @since 10 + */ + putBatch(value: Array): Promise; + + /** + * Deletes the key-value pair based on a specified key. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @param { AsyncCallback } callback - the callback of delete. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Deletes the key-value pair based on a specified key. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @param { AsyncCallback } callback - the callback of delete. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + delete(key: string, callback: AsyncCallback): void; + + /** + * Deletes the key-value pair based on a specified key. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Deletes the key-value pair based on a specified key. + * + * @param { string } key - Indicates the key. Length must be less than {@code MAX_KEY_LENGTH}. + * Spaces before and after the key will be cleared. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + delete(key: string): Promise; + + /** + * Deletes the key-value pairs based on the dataSharePredicates. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @param { AsyncCallback } callback - the callback of delete. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Deletes the key-value pairs based on the dataSharePredicates. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @param { AsyncCallback } callback - the callback of delete. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback): void; + + /** + * Deletes the key-value pairs based on the dataSharePredicates. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Deletes the key-value pairs based on the dataSharePredicates. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + delete(predicates: dataSharePredicates.DataSharePredicates): Promise; + + /** + * Deletes key-value pairs in batches from the {@code SingleKVStore} database. + * + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. + * @param { AsyncCallback } callback - the callback of deleteBatch. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Deletes key-value pairs in batches from the {@code SingleKVStore} database. + * + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. + * @param { AsyncCallback } callback - the callback of deleteBatch. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + deleteBatch(keys: string[], callback: AsyncCallback): void; + + /** + * Deletes key-value pairs in batches from the {@code SingleKVStore} database. + * + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Deletes key-value pairs in batches from the {@code SingleKVStore} database. + * + * @param { string[] } keys - Indicates the key-value pairs to be deleted in batches, It can not be empty. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + deleteBatch(keys: string[]): Promise; + + /** + * Removes data of the specified device from current database. This method is used to remove only the data + * synchronized from remote devices. This operation does not synchronize data to other databases or affect + * subsequent data synchronization. + * + * @param { string } deviceId - Identifies the device whose data is to be removed and the value cannot be the current device ID. + * @param { AsyncCallback } callback - the callback of removeDeviceData. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + removeDeviceData(deviceId: string, callback: AsyncCallback): void; + + /** + * Removes data of the specified device from current database. This method is used to remove only the data + * synchronized from remote devices. This operation does not synchronize data to other databases or affect + * subsequent data synchronization. + * + * @param { string } deviceId - Identifies the device whose data is to be removed and the value cannot be the current device ID. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + removeDeviceData(deviceId: string): Promise; + + /** + * Obtains the value of a specified key. + * + * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. + * @param { AsyncCallback } callback - + * {Uint8Array|string|boolean|number}: the returned value specified by the key. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + get(key: string, callback: AsyncCallback): void; + + /** + * Obtains the value of a specified key. + * + * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. + * @returns { Promise } + * {Uint8Array|string|boolean|number}: the returned value specified by the key. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + get(key: string): Promise; + + /** + * Obtains all key-value pairs that match a specified key prefix. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs + * that match the specified key prefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(keyPrefix: string, callback: AsyncCallback): void; + + /** + * Obtains all key-value pairs that match a specified key prefix. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {Entry[]}: the list of all key-value pairs that match the + * specified key prefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(keyPrefix: string): Promise; + + /** + * Obtains the list of key-value pairs matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs + * matching the specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(query: Query, callback: AsyncCallback): void; + + /** + * Obtains the list of key-value pairs matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {Entry[]}: the list of all key-value pairs matching the + * specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(query: Query): Promise; + + /** + * Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet} + * object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created + * four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet + * method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet} + * object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created + * four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet + * method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(keyPrefix: string, callback: AsyncCallback): void; + + /** + * Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet} + * object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created + * four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet + * method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the result set with a specified prefix from a {@code SingleKVStore} database. The {@code KVStoreResultSet} + * object can be used to query all key-value pairs that meet the search criteria. Each {@code SingleKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created + * four objects, calling this method will return a failure. Therefore, you are advised to call the closeResultSet + * method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(keyPrefix: string): Promise; + + /** + * Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(query: Query, callback: AsyncCallback): void; + + /** + * Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(query: Query): Promise; + + /** + * Obtains the KVStoreResultSet object matching the specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Obtains the KVStoreResultSet object matching the specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback): void; + + /** + * Obtains the KVStoreResultSet object matching the specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Obtains the KVStoreResultSet object matching the specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise; + + /** + * Closes a {@code KVStoreResultSet} object returned by getResultSet method. + * + * @param { KVStoreResultSet } resultSet - Indicates the {@code KVStoreResultSet} object to close. + * @param { AsyncCallback } callback - the callback of closeResultSet. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + closeResultSet(resultSet: KVStoreResultSet, callback: AsyncCallback): void; + + /** + * Closes a {@code KVStoreResultSet} object returned by getResultSet method. + * + * @param { KVStoreResultSet } resultSet - Indicates the {@code KVStoreResultSet} object to close. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + closeResultSet(resultSet: KVStoreResultSet): Promise; + + /** + * Obtains the number of results matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {number}: the number of results matching the + * specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getResultSize(query: Query, callback: AsyncCallback): void; + + /** + * Obtains the number of results matching the specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {number}: the number of results matching the specified + * {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getResultSize(query: Query): Promise; + + /** + * Backs up a database in the specified filename. + * + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. + * @param { AsyncCallback } callback - the callback of backup. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + backup(file: string, callback: AsyncCallback): void; + + /** + * Backs up a database in the specified filename. + * + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + backup(file: string): Promise; + + /** + * Restores a database from a specified database file. + * + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. + * @param { AsyncCallback } callback - the callback of restore. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + restore(file: string, callback: AsyncCallback): void; + + /** + * Restores a database from a specified database file. + * + * @param { string } file - Indicates the database backup filename, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + restore(file: string): Promise; + + /** + * Delete database backup files based on the specified filenames. + * + * @param { Array } files - Indicates the backup filenames to be deleted, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. + * @param { AsyncCallback> } callback - {Array<[string, number]>}: + * the list of backup file and it's corresponding delete result which 0 means delete success + * and otherwise failed. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deleteBackup(files: Array, callback: AsyncCallback>): void; + + /** + * Delete database backup files based on the specified filenames. + * + * @param { Array } files - Indicates the backup filenames to be deleted, It can not be empty and + * The length must be less than {@code MAX_KEY_LENGTH}. + * @returns { Promise> } {Array<[string, number]>}: the list of backup + * file and it's corresponding delete result which 0 means delete success and otherwise failed. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deleteBackup(files: Array): Promise>; + + /** + * Starts a transaction operation in the {@code SingleKVStore} database. + *

After the database transaction is started, you can submit or roll back the operation. + * + * @param { AsyncCallback } callback - the callback of startTransaction. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Starts a transaction operation in the {@code SingleKVStore} database. + *

After the database transaction is started, you can submit or roll back the operation. + * + * @param { AsyncCallback } callback - the callback of startTransaction. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + startTransaction(callback: AsyncCallback): void; + + /** + * Starts a transaction operation in the {@code SingleKVStore} database. + *

After the database transaction is started, you can submit or roll back the operation. + * + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Starts a transaction operation in the {@code SingleKVStore} database. + *

After the database transaction is started, you can submit or roll back the operation. + * + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + startTransaction(): Promise; + + /** + * Submits a transaction operation in the {@code SingleKVStore} database. + * + * @param { AsyncCallback } callback - the callback of commit. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + commit(callback: AsyncCallback): void; + + /** + * Submits a transaction operation in the {@code SingleKVStore} database. + * + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + commit(): Promise; + + /** + * Rolls back a transaction operation in the {@code SingleKVStore} database. + * + * @param { AsyncCallback } callback - the callback of rollback. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + rollback(callback: AsyncCallback): void; + + /** + * Rolls back a transaction operation in the {@code SingleKVStore} database. + * + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + rollback(): Promise; + + /** + * Sets whether to enable synchronization. + * + * @param { boolean } enabled - Specifies whether to enable synchronization. The value true + * means to enable synchronization, and false means the opposite. + * @param { AsyncCallback } callback - the callback of enableSync. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + enableSync(enabled: boolean, callback: AsyncCallback): void; + + /** + * Sets whether to enable synchronization. + * + * @param { boolean } enabled - Specifies whether to enable synchronization. The value true + * means to enable synchronization, and false means the opposite. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + enableSync(enabled: boolean): Promise; + + /** + * Sets synchronization range labels. + *

The labels determine the devices with which data will be synchronized. + * + * @param { string[] } localLabels - Indicates the synchronization labels of the local device. + * @param { string[] } remoteSupportLabels - Indicates the labels of the devices with which + * data will be synchronized. + * @param { AsyncCallback } callback - the callback of setSyncRange. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback): void; + + /** + * Sets synchronization range labels. + *

The labels determine the devices with which data will be synchronized. + * + * @param { string[] } localLabels - Indicates the synchronization labels of the local device. + * @param { string[] } remoteSupportLabels - Indicates the labels of the devices with which + * data will be synchronized. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise; + + /** + * Sets the default delay allowed for database synchronization + * + * @param { number } defaultAllowedDelayMs - Indicates the default delay allowed for the + * database synchronization, in milliseconds. + * @param { AsyncCallback } callback - the callback of setSyncParam. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback): void; + + /** + * Sets the default delay allowed for database synchronization + * + * @param { number } defaultAllowedDelayMs - Indicates the default delay allowed for the + * database synchronization, in milliseconds. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + setSyncParam(defaultAllowedDelayMs: number): Promise; + + /** + * Synchronize the database to the specified devices with the specified delay allowed. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string[] } deviceIds - Indicates the list of devices to which to synchronize the database. + * @param { SyncMode } mode - Indicates the synchronization mode. The value can be {@code PUSH}, + * {@code PULL}, or {@code PUSH_PULL}. + * @param { number } delayMs - Indicates the delay allowed for the synchronization, in milliseconds. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void; + + /** + * Synchronize the database to the specified devices with the specified delay allowed. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string[] } deviceIds - Indicates the list of devices to which to synchronize the database. + * @param { Query } query - Indicates the {@code Query} object. + * @param { SyncMode } mode - Indicates the synchronization mode. The value can be {@code PUSH}, + * {@code PULL}, or {@code PUSH_PULL}. + * @param { number } delayMs - Indicates the delay allowed for the synchronization, in milliseconds. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void; + + /** + * Register a callback to the database and when data in the distributed database has changed, + * the callback will be invoked. + * + * @param { 'dataChange' } event - Subscribed event name, fixed as 'dataChange', indicates the data change event. + * @param { SubscribeType } type - Indicates the subscription type, which is defined in {@code SubscribeType}. + * @param { Callback } listener - {ChangeNotification}: the {@code ChangeNotification} + * object indicates the data change events in the distributed database. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Register a callback to the database and when data in the distributed database has changed, + * the callback will be invoked. + * + * @param { 'dataChange' } event - Subscribed event name, fixed as 'dataChange', indicates the data change event. + * @param { SubscribeType } type - Indicates the subscription type, which is defined in {@code SubscribeType}. + * @param { Callback } listener - {ChangeNotification}: the {@code ChangeNotification} + * object indicates the data change events in the distributed database. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + on(event: 'dataChange', type: SubscribeType, listener: Callback): void; + + /** + * Register a databases synchronization callback to the database. + *

Sync result is returned through asynchronous callback. + * + * @param { 'syncComplete' } event - Subscribed event name, fixed as 'syncComplete', indicates the synchronization completion event. + * @param { Callback> } syncCallback - {Array<[string, number]>}: the + * deviceId and it's corresponding synchronization result which 0 means synchronization success + * and otherwise failed. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + on(event: 'syncComplete', syncCallback: Callback>): void; + + /** + * Unsubscribe from the SingleKVStore database based on the specified subscribeType and listener. + * + * @param { 'dataChange' } event - The unsubscribe event name, fixed as 'dataChange', indicates the data change event. + * @param { Callback } listener - {ChangeNotification}: the {@code ChangeNotification} + * object indicates the data change events in the distributed database. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + off(event: 'dataChange', listener?: Callback): void; + + /** + * Unregister the database synchronization callback. + * + * @param { 'syncComplete' } event - The unsubscribe event name, fixed as 'syncComplete', indicates the synchronization completion event. + * @param { Callback> } syncCallback - {Array<[string, number]>}: the + * deviceId and it's corresponding synchronization result which 0 means synchronization success + * and otherwise failed. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + off(event: 'syncComplete', syncCallback?: Callback>): void; + + /** + * Get the security level of the database. + * + * @param { AsyncCallback } callback - {SecurityLevel}: the {@code SecurityLevel} + * object indicates the security level of the database. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getSecurityLevel(callback: AsyncCallback): void; + + /** + * Get the security level of the database. + * + * @returns { Promise } {SecurityLevel}: the {@code SecurityLevel} object indicates + * the security level of the database. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getSecurityLevel(): Promise; + } + + /** + * Provides methods related to device-collaboration distributed databases. + *

To create a {@code DeviceKVStore} database, you can use the {@link data.distributed.common.KVManager.getKVStore(Options, String)} + * method with {@code KVStoreType} set to {@code DEVICE_COLLABORATION} for the input parameter Options. This database manages distributed + * data by device, and cannot modify data synchronized from remote devices. When an application writes a key-value pair entry + * into the database, the system automatically adds the ID of the device running the application to the key. + * + * @interface DeviceKVStore + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + export interface DeviceKVStore extends SingleKVStore { + /** + * Obtains the value matching the local device ID and specified key. + * + * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. + * @param { AsyncCallback } callback - + * {Uint8Array|string|boolean|number}: the returned value specified by the local device ID and specified key. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + get(key: string, callback: AsyncCallback): void; + + /** + * Obtains the value matching the local device ID and specified key. + * + * @param { string } key - Indicates the key. The length must be less than {@code MAX_KEY_LENGTH}. + * @returns { Promise } + * {Uint8Array|string|boolean|number}: the returned value specified by the local device ID and specified key. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + get(key: string): Promise; + + /** + * Obtains the value matching a specified device ID and key. + * + * @param { string } deviceId - Indicates the device to be queried. + * @param { string } key - Indicates the key of the value to be queried. The length must be less than {@code MAX_KEY_LENGTH}. + * @param { AsyncCallback } callback - + * {boolean | string | number | Uint8Array}: the returned value specified by the deviceId and key. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + get(deviceId: string, key: string, callback: AsyncCallback): void; + + /** + * Obtains the value matching a specified device ID and key. + * + * @param { string } deviceId - Indicates the device to be queried. + * @param { string } key - Indicates the key of the value to be queried. The length must be less than {@code MAX_KEY_LENGTH}. + * @returns { Promise } + * {Uint8Array|string|boolean|number}: the returned value specified by the deviceId and key. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100004 - Not found. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + get(deviceId: string, key: string): Promise; + + /** + * Obtains all key-value pairs that match the local device ID and specified key prefix. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs + * that match the local device ID and specified key prefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(keyPrefix: string, callback: AsyncCallback): void; + + /** + * Obtains all key-value pairs that match the local device ID and specified key prefix. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {Entry[]}: the list of all key-value pairs that match the + * local device ID and specified key prefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(keyPrefix: string): Promise; + + /** + * Obtains all key-value pairs matching a specified device ID and key prefix. + * + * @param { string } deviceId - Identifies the device whose data is to be queried. + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs + * that match the specified deviceId and key prefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback): void; + + /** + * Obtains all key-value pairs matching a specified device ID and key prefix. + * + * @param { string } deviceId - Identifies the device whose data is to be queried. + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {Entry[]}: the list of all key-value pairs that match the + * specified deviceId and key prefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + getEntries(deviceId: string, keyPrefix: string): Promise; + + /** + * Obtains the list of key-value pairs matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs + * matching the local device ID and specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(query: Query, callback: AsyncCallback): void; + + /** + * Obtains the list of key-value pairs matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {Entry[]}: the list of all key-value pairs matching the local device ID and + * specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getEntries(query: Query): Promise; + + /** + * Obtains the list of key-value pairs matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the key-value pairs belong. + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {Entry[]}: the list of all key-value pairs + * matching the specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + getEntries(deviceId: string, query: Query, callback: AsyncCallback): void; + + /** + * Obtains the list of key-value pairs matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the key-value pairs belong. + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {Entry[]}: the list of all key-value pairs matching the + * specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + getEntries(deviceId: string, query: Query): Promise; + + /** + * Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database. + * The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. + * Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. + * If you have created four objects, calling this method will return a failure. Therefore, you are advised to + * call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database. + * The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. + * Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. + * If you have created four objects, calling this method will return a failure. Therefore, you are advised to + * call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(keyPrefix: string, callback: AsyncCallback): void; + + /** + * Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database. + * The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. + * Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. + * If you have created four objects, calling this method will return a failure. Therefore, you are advised to + * call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the result set with the local device ID and specified prefix from a {@code DeviceKVStore} database. + * The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. + * Each {@code DeviceKVStore} instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. + * If you have created four objects, calling this method will return a failure. Therefore, you are advised to + * call the closeResultSet method to close unnecessary {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(keyPrefix: string): Promise; + + /** + * Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix. + *

The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects, + * calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary + * {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } deviceId - Identifies the device whose data is to be queried. + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix. + *

The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects, + * calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary + * {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } deviceId - Identifies the device whose data is to be queried. + * @param { string } keyPrefix - Indicates the key prefix to match. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 10 + */ + getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback): void; + + /** + * Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix. + *

The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects, + * calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary + * {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } deviceId - Identifies the device whose data is to be queried. + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching the specified device ID and key prefix. + *

The {@code KVStoreResultSet} object can be used to query all key-value pairs that meet the search criteria. Each {@code DeviceKVStore} + * instance can have a maximum of four {@code KVStoreResultSet} objects at the same time. If you have created four objects, + * calling this method will return a failure. Therefore, you are advised to call the closeResultSet method to close unnecessary + * {@code KVStoreResultSet} objects in a timely manner. + * + * @param { string } deviceId - Identifies the device whose data is to be queried. + * @param { string } keyPrefix - Indicates the key prefix to match. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and keyPrefix. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 10 + */ + getResultSet(deviceId: string, keyPrefix: string): Promise; + + /** + * Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(query: Query, callback: AsyncCallback): void; + + /** + * Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 10 + */ + getResultSet(query: Query): Promise; + + /** + * Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs. + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs. + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 10 + */ + getResultSet(deviceId: string, query: Query, callback: AsyncCallback): void; + + /** + * Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs. + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + /** + * Obtains the {@code KVStoreResultSet} object matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the {@code KVStoreResultSet} object belongs. + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 10 + */ + getResultSet(deviceId: string, query: Query): Promise; + + /** + * Obtains the KVStoreResultSet object matching the local device ID and specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Obtains the KVStoreResultSet object matching the local device ID and specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback): void; + + /** + * Obtains the KVStoreResultSet object matching the local device ID and specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Obtains the KVStoreResultSet object matching the local device ID and specified predicate object. + * + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the datasharePredicates. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the local device ID and specified {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise; + + /** + * Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object. + * + * @param { string } deviceId Indicates the ID of the device to which the results belong. + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object. + * + * @param { string } deviceId Indicates the ID of the device to which the results belong. + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @param { AsyncCallback } callback - {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + getResultSet( + deviceId: string, + predicates: dataSharePredicates.DataSharePredicates, + callback: AsyncCallback + ): void; + + /** + * Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object. + * + * @param { string } deviceId Indicates the ID of the device to which the results belong. + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 9 + */ + /** + * Obtains the KVStoreResultSet object matching a specified Device ID and Predicate object. + * + * @param { string } deviceId Indicates the ID of the device to which the results belong. + * @param { dataSharePredicates.DataSharePredicates } predicates - Indicates the dataSharePredicates. + * @returns { Promise } {KVStoreResultSet}: the {@code KVStoreResultSet} + * object matching the specified deviceId and {@code dataSharePredicates.DataSharePredicates} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 15100001 - Over max limits. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.DataShare.Provider + * @systemapi + * @StageModelOnly + * @since 10 + */ + getResultSet(deviceId: string, predicates: dataSharePredicates.DataSharePredicates): Promise; + + /** + * Obtains the number of results matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {number}: the number of results matching the + * local device ID and specified {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getResultSize(query: Query, callback: AsyncCallback): void; + + /** + * Obtains the number of results matching the local device ID and specified {@code Query} object. + * + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {number}: the number of results matching the local device ID and specified + * {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getResultSize(query: Query): Promise; + + /** + * Obtains the number of results matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the results belong. + * @param { Query } query - Indicates the {@code Query} object. + * @param { AsyncCallback } callback - {number}: the number of results matching the + * specified deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + getResultSize(deviceId: string, query: Query, callback: AsyncCallback): void; + + /** + * Obtains the number of results matching a specified device ID and {@code Query} object. + * + * @param { string } deviceId - Indicates the ID of the device to which the results belong. + * @param { Query } query - Indicates the {@code Query} object. + * @returns { Promise } {number}: the number of results matching the specified + * deviceId and {@code Query} object. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types. + * @throws { BusinessError } 15100003 - Database corrupted. + * @throws { BusinessError } 15100005 - Database or result set already closed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + getResultSize(deviceId: string, query: Query): Promise; + } + + /** + * Creates a {@link KVManager} instance based on the configuration information. + *

You must pass {@link KVManagerConfig} to provide configuration information + * to create a {@link KVManager} instance. + * + * @param { KVManagerConfig } config - Indicates the KVStore configuration information, + * including the package name and context, and package name can not be empty. + * @returns { KVManager } : the {@code KVManager} instance. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export function createKVManager(config: KVManagerConfig): KVManager; + + /** + * Provides interfaces to manage a {@code SingleKVStore} database, including obtaining, closing, and deleting the {@code SingleKVStore}. + * + * @interface KVManager + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + export interface KVManager { + /** + * Creates and obtains a KVStore database by specifying {@code Options} and {@code storeId}. + * + * @param { string } storeId - Identifies the KVStore database. The value of this parameter must be unique + * for the same application, and different applications can share the same value. The storeId can consist + * of only letters, digits, and underscores (_), and cannot exceed 128 characters. + * @param { Options } options - Indicates the {@code Options} object used for creating and + * obtaining the KVStore database. + * @param { AsyncCallback } callback - {T}: the {@code SingleKVStore} or {@code DeviceKVStore} instance. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100002 - Open existed database with changed options. + * @throws { BusinessError } 15100003 - Database corrupted. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getKVStore(storeId: string, options: Options, callback: AsyncCallback): void; + + /** + * Creates and obtains a KVStore database by specifying {@code Options} and {@code storeId}. + * + * @param { string } storeId - Identifies the KVStore database. The value of this parameter must be unique + * for the same application, and different applications can share the same value. The storeId can consist + * of only letters, digits, and underscores (_), and cannot exceed 128 characters. + * @param { Options } options - Indicates the {@code Options} object used for creating and + * obtaining the KVStore database. + * @returns { Promise } {T}: the {@code SingleKVStore} or {@code DeviceKVStore} instance. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @throws { BusinessError } 15100002 - Open existed database with changed options. + * @throws { BusinessError } 15100003 - Database corrupted. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getKVStore(storeId: string, options: Options): Promise; + + /** + * Closes the KVStore database. + *

Warning: This method is not thread-safe. If you call this method to stop a KVStore database that is running, your + * thread may crash. + *

The KVStore database to close must be an object created by using the {@code getKVStore} method. Before using this + * method, release the resources created for the database, for example, {@code KVStoreResultSet} for KVStore, otherwise + * closing the database will fail. + * + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. + * @param { string } storeId - Identifies the KVStore database to close. The storeId can consist of only letters, digits, + * and underscores (_), and cannot exceed 128 characters. + * @param { AsyncCallback } callback - the callback of closeKVStore. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + closeKVStore(appId: string, storeId: string, callback: AsyncCallback): void; + + /** + * Closes the KVStore database. + *

Warning: This method is not thread-safe. If you call this method to stop a KVStore database that is running, your + * thread may crash. + *

The KVStore database to close must be an object created by using the {@code getKVStore} method. Before using this + * method, release the resources created for the database, for example, {@code KVStoreResultSet} for KVStore, otherwise + * closing the database will fail. + * + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. + * @param { string } storeId - Identifies the KVStore database to close. The storeId can consist of only letters, digits, + * and underscores (_), and cannot exceed 128 characters. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + closeKVStore(appId: string, storeId: string): Promise; + + /** + * Deletes the KVStore database identified by storeId. + *

Before using this method, close all KVStore instances in use that are identified by the same storeId. + *

You can use this method to delete a KVStore database not in use. After the database is deleted, all its data will be + * lost. + * + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. + * @param { string } storeId - Identifies the KVStore database to delete. The storeId can consist of only letters, digits, + * and underscores (_), and cannot exceed 128 characters. + * @param { AsyncCallback } callback - the callback of deleteKVStore. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100004 - Not found. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deleteKVStore(appId: string, storeId: string, callback: AsyncCallback): void; + + /** + * Deletes the KVStore database identified by storeId. + *

Before using this method, close all KVStore instances in use that are identified by the same storeId. + *

You can use this method to delete a KVStore database not in use. After the database is deleted, all its data will be + * lost. + * + * @param { string } appId - Identifies the application that the database belong to, and cannot exceed 256 characters. + * @param { string } storeId - Identifies the KVStore database to delete. The storeId can consist of only letters, digits, + * and underscores (_), and cannot exceed 128 characters. + * @returns { Promise } the promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @throws { BusinessError } 15100004 - Not found. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + deleteKVStore(appId: string, storeId: string): Promise; + + /** + * Obtains the storeId of all KVStore databases that are created by using the {@code getKVStore} method and not deleted by + * calling the {@code deleteKVStore} method. + * + * @param { string } appId - Identifies the application that obtains the databases, and cannot exceed 256 characters. + * @param { AsyncCallback } callback - {string[]}: the storeId of all created KVStore databases. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getAllKVStoreId(appId: string, callback: AsyncCallback): void; + + /** + * Obtains the storeId of all KVStore databases that are created by using the {@code getKVStore} method and not deleted by + * calling the {@code deleteKVStore} method. + * + * @param { string } appId - Identifies the application that obtains the databases, and cannot exceed 256 characters. + * @returns { Promise } {string[]}: the storeId of all created KVStore databases. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified. + *
2.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.Core + * @since 9 + */ + getAllKVStoreId(appId: string): Promise; + + /** + * Register a death callback to get notification when the data manager service is terminated. + *

If the data manager service is terminated,you need to re-subscribe to data change notifications and synchronization + * completion notifications, and calling the sync method will return a failure. + * + * @param { 'distributedDataServiceDie' } event - Subscribed event name, fixed as 'distributedDataServiceDie', as a service status change events. + * @param { Callback } deathCallback - callback to be invoked when the data manager service is terminated. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + on(event: 'distributedDataServiceDie', deathCallback: Callback): void; + + /** + * Unregister the death callback. Not notification will be received when the data manager service is terminated. + *

The unregistered death callback must be a registered death callback of the database. If no death callback parameter + * is passed, all database death callbacks will be unregistered. + * + * @param { 'distributedDataServiceDie' } event - Unsubscribe event name, fixed as 'distributedDataServiceDie', as a service status change events. + * @param { Callback } deathCallback - the data manager service is terminated callback which has been registered. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameters types; + *
3.Parameter verification failed. + * @syscap SystemCapability.DistributedDataManager.KVStore.DistributedKVStore + * @since 9 + */ + off(event: 'distributedDataServiceDie', deathCallback?: Callback): void; + } +} + +export default distributedKVStore; \ No newline at end of file diff --git a/api/@ohos.data.preferences.d.ts b/api/@ohos.data.preferences.d.ts index 89ead370650317bf035882dc4acecdbdbaf11319..e7ef458150ff6fc7cd8fd75c2ff7b28cf32baeb6 100644 --- a/api/@ohos.data.preferences.d.ts +++ b/api/@ohos.data.preferences.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022 Huawei Device Co., Ltd. + * Copyright (c) 2022-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 @@ -45,7 +45,8 @@ import Context from './application/BaseContext'; * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 * @name preferences */ declare namespace preferences { @@ -77,7 +78,8 @@ declare namespace preferences { * @typedef {number | string | boolean | Array | Array | Array | Uint8Array | object | bigint} * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type ValueType = number | string | boolean | Array | Array | Array | Uint8Array | object | bigint; @@ -192,7 +194,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Options { /** @@ -209,7 +212,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -227,7 +231,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @StageModelOnly * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ dataGroupId?: string | null | undefined; @@ -289,7 +294,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getPreferences(context: Context, name: string, callback: AsyncCallback): void; @@ -331,7 +337,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getPreferences(context: Context, options: Options, callback: AsyncCallback): void; @@ -379,7 +386,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getPreferences(context: Context, name: string): Promise; @@ -419,7 +427,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getPreferences(context: Context, options: Options): Promise; @@ -461,7 +470,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getPreferencesSync(context: Context, options: Options): Preferences; @@ -531,7 +541,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function deletePreferences(context: Context, name: string, callback: AsyncCallback): void; @@ -579,7 +590,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function deletePreferences(context: Context, options: Options, callback: AsyncCallback): void; @@ -639,7 +651,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function deletePreferences(context: Context, name: string): Promise; @@ -687,7 +700,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function deletePreferences(context: Context, options: Options): Promise; @@ -741,7 +755,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void; @@ -785,7 +800,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function removePreferencesFromCache(context: Context, options: Options, callback: AsyncCallback): void; @@ -839,7 +855,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function removePreferencesFromCache(context: Context, name: string): Promise; @@ -883,7 +900,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function removePreferencesFromCache(context: Context, options: Options): Promise; @@ -919,7 +937,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function removePreferencesFromCacheSync(context: Context, name: string): void; @@ -961,7 +980,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function removePreferencesFromCacheSync(context: Context, options: Options): void; @@ -999,7 +1019,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Preferences { /** @@ -1049,7 +1070,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ get(key: string, defValue: ValueType, callback: AsyncCallback): void; @@ -1100,7 +1122,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ get(key: string, defValue: ValueType): Promise; @@ -1136,7 +1159,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getSync(key: string, defValue: ValueType): ValueType; @@ -1166,7 +1190,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAll(callback: AsyncCallback): void; @@ -1193,7 +1218,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAll(): Promise; @@ -1215,7 +1241,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllSync(): Object; @@ -1260,7 +1287,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ has(key: string, callback: AsyncCallback): void; @@ -1305,7 +1333,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ has(key: string): Promise; @@ -1339,7 +1368,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ hasSync(key: string): boolean; @@ -1393,7 +1423,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ put(key: string, value: ValueType, callback: AsyncCallback): void; @@ -1447,7 +1478,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ put(key: string, value: ValueType): Promise; @@ -1483,7 +1515,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ putSync(key: string, value: ValueType): void; @@ -1531,7 +1564,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ delete(key: string, callback: AsyncCallback): void; @@ -1579,7 +1613,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ delete(key: string): Promise; @@ -1611,7 +1646,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ deleteSync(key: string): void; @@ -1644,7 +1680,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ clear(callback: AsyncCallback): void; @@ -1674,7 +1711,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ clear(): Promise; @@ -1693,7 +1731,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ clearSync(): void; @@ -1723,7 +1762,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ flush(callback: AsyncCallback): void; @@ -1750,7 +1790,8 @@ declare namespace preferences { * @syscap SystemCapability.DistributedDataManager.Preferences.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ flush(): Promise; diff --git a/api/@ohos.data.relationalStore.d.ts b/api/@ohos.data.relationalStore.d.ts index 9416883248c709d5ccc4969635fe1d54f75174d8..e1d3b94b0a5cbba68e9ed6a2d4cb62e826b0d606 100644 --- a/api/@ohos.data.relationalStore.d.ts +++ b/api/@ohos.data.relationalStore.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2023 Huawei Device Co., Ltd. + * Copyright (c) 2023-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 @@ -21,7 +21,10 @@ import { AsyncCallback, Callback } from './@ohos.base'; import Context from './application/BaseContext'; import dataSharePredicates from './@ohos.data.dataSharePredicates'; +/*** if arkts 1.1 */ import sendableRelationalStore from './@ohos.data.sendableRelationalStore'; +import { int, long, double } from './@ohos.base'; +/*** endif */ /** * Provides methods for rdbStore create and delete. * @@ -35,7 +38,8 @@ import sendableRelationalStore from './@ohos.data.sendableRelationalStore'; * @namespace relationalStore * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace relationalStore { /** @@ -44,7 +48,8 @@ declare namespace relationalStore { * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum AssetStatus { /** @@ -52,7 +57,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_NORMAL, @@ -61,7 +67,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_INSERT, @@ -70,7 +77,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_UPDATE, @@ -79,7 +87,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_DELETE, @@ -88,7 +97,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_ABNORMAL, @@ -97,7 +107,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_DOWNLOADING } @@ -108,7 +119,8 @@ declare namespace relationalStore { * @interface Asset * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Asset { /** @@ -117,7 +129,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -127,7 +140,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; @@ -137,7 +151,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ path: string; @@ -147,7 +162,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ createTime: string; @@ -157,7 +173,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ modifyTime: string; @@ -167,7 +184,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ size: string; @@ -177,7 +195,8 @@ declare namespace relationalStore { * @type { ?AssetStatus } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ status?: AssetStatus; } @@ -188,21 +207,22 @@ declare namespace relationalStore { * @typedef { Asset[] } Assets * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type Assets = Asset[]; /** * Indicates possible value types * - * @typedef { null | number | string | boolean | Uint8Array } ValueType + * @typedef { null | long | double | string | boolean | Uint8Array } ValueType * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @since 9 */ /** * Indicates possible value types * - * @typedef { null | number | string | boolean | Uint8Array | Asset | Assets } ValueType + * @typedef { null | long | double | string | boolean | Uint8Array | Asset | Assets } ValueType * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform * @since 10 @@ -210,12 +230,13 @@ declare namespace relationalStore { /** * Indicates possible value types * - * @typedef { null | number | string | boolean | Uint8Array | Asset | Assets | Float32Array | bigint } ValueType + * @typedef { null | long | double | string | boolean | Uint8Array | Asset | Assets | Float32Array | bigint } ValueType * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - type ValueType = null | number | string | boolean | Uint8Array | Asset | Assets | Float32Array | bigint; + type ValueType = null | long | double | string | boolean | Uint8Array | Asset | Assets | Float32Array | bigint; /** * Values in buckets are stored in key-value pairs @@ -238,25 +259,27 @@ declare namespace relationalStore { * @typedef { Record } ValuesBucket * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type ValuesBucket = Record; - /** * The type of the priority key can be number or string * - * @typedef { number | string } PRIKeyType + * @typedef { long | double | string } PRIKeyType * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - type PRIKeyType = number | string; + type PRIKeyType = long | double | string; /** * The time is in UTC format. * * @typedef { Date } UTCTime * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type UTCTime = Date; @@ -265,7 +288,8 @@ declare namespace relationalStore { * * @typedef { Map } ModifyTime * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type ModifyTime = Map; @@ -282,7 +306,8 @@ declare namespace relationalStore { * @interface StoreConfig * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface StoreConfig { /** @@ -297,7 +322,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -307,7 +333,8 @@ declare namespace relationalStore { * @type { SecurityLevel } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ securityLevel: SecurityLevel; @@ -316,7 +343,8 @@ declare namespace relationalStore { * * @type { ?boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ encrypt?: boolean; @@ -326,7 +354,8 @@ declare namespace relationalStore { * @type { ?string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @StageModelOnly - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ dataGroupId?: string; @@ -336,7 +365,8 @@ declare namespace relationalStore { * @type { ?string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ customDir?: string; @@ -356,7 +386,8 @@ declare namespace relationalStore { * * @type { ?boolean } * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ autoCleanDirtyData?: boolean; @@ -375,7 +406,8 @@ declare namespace relationalStore { * * @type { ?boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ allowRebuild?: boolean; @@ -384,7 +416,8 @@ declare namespace relationalStore { * * @type { ?boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ vector?: boolean; @@ -394,7 +427,8 @@ declare namespace relationalStore { * * @type { ?boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isReadOnly?: boolean; @@ -403,7 +437,8 @@ declare namespace relationalStore { * * @type { ?Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ pluginLibs?: Array; @@ -422,7 +457,8 @@ declare namespace relationalStore { * * @type { ?CryptoParam } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ cryptoParam?: CryptoParam; @@ -453,7 +489,8 @@ declare namespace relationalStore { * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum HAMode { /** @@ -461,7 +498,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SINGLE = 0, @@ -470,7 +508,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MAIN_REPLICA } @@ -480,7 +519,8 @@ declare namespace relationalStore { * * @typedef CryptoParam * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CryptoParam { /** @@ -489,7 +529,8 @@ declare namespace relationalStore { * * @type { Uint8Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ encryptionKey: Uint8Array; @@ -498,11 +539,12 @@ declare namespace relationalStore { * Default number is 10000. * When the number is set to 0, use default iteration number and encryption algorithm. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - iterationCount?: number; + iterationCount?: int; /** * Specifies the encryption algorithm when opening an encrypted database. @@ -510,7 +552,8 @@ declare namespace relationalStore { * * @type { ?EncryptionAlgo } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ encryptionAlgo?: EncryptionAlgo; @@ -520,7 +563,8 @@ declare namespace relationalStore { * * @type { ?HmacAlgo } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ hmacAlgo?: HmacAlgo; @@ -530,7 +574,8 @@ declare namespace relationalStore { * * @type { ?KdfAlgo } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ kdfAlgo?: KdfAlgo; @@ -538,11 +583,12 @@ declare namespace relationalStore { * Specifies the page size used when opening an encrypted database. * Default crypto page size is 1024. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - cryptoPageSize?: number; + cryptoPageSize?: int; } /** @@ -550,14 +596,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ enum EncryptionAlgo { /** * AES_256_GCM: Database is encrypted using AES_256_GCM. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ AES_256_GCM = 0, @@ -565,7 +613,8 @@ declare namespace relationalStore { * AES_256_CBC: Database is encrypted using AES_256_CBC. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ AES_256_CBC } @@ -575,14 +624,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ enum HmacAlgo { /** * SHA1: HMAC_SHA1 algorithm. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SHA1 = 0, @@ -590,7 +641,8 @@ declare namespace relationalStore { * SHA256: HMAC_SHA256 algorithm. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SHA256, @@ -598,7 +650,8 @@ declare namespace relationalStore { * SHA512: HMAC_SHA512 algorithm. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ SHA512 } @@ -608,14 +661,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ enum KdfAlgo { /** * KDF_SHA1: PBKDF2_HMAC_SHA1 algorithm. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ KDF_SHA1 = 0, @@ -623,7 +678,8 @@ declare namespace relationalStore { * KDF_SHA256: PBKDF2_HMAC_SHA256 algorithm. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ KDF_SHA256, @@ -631,7 +687,8 @@ declare namespace relationalStore { * KDF_SHA512: PBKDF2_HMAC_SHA512 algorithm. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ KDF_SHA512 } @@ -672,14 +729,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum Progress { /** * SYNC_BEGIN: means the sync process begin. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_BEGIN, @@ -687,7 +746,8 @@ declare namespace relationalStore { * SYNC_BEGIN: means the sync process is in progress * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_IN_PROGRESS, @@ -695,7 +755,8 @@ declare namespace relationalStore { * SYNC_BEGIN: means the sync process is finished * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_FINISH } @@ -705,44 +766,49 @@ declare namespace relationalStore { * * @interface Statistic * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Statistic { /** * Describes the total number of data to sync. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - total: number; + total: int; /** * Describes the number of successfully synced data. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - successful: number; + successful: int; /** * Describes the number of data failed to sync. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - failed: number; + failed: int; /** * Describes the number of data remained to sync. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - remained: number; + remained: int; } /** @@ -750,7 +816,8 @@ declare namespace relationalStore { * * @interface TableDetails * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface TableDetails { /** @@ -758,7 +825,8 @@ declare namespace relationalStore { * * @type { Statistic } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ upload: Statistic; @@ -767,7 +835,8 @@ declare namespace relationalStore { * * @type { Statistic } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ download: Statistic; } @@ -777,14 +846,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ProgressCode { /** * SUCCESS: means the status of progress is success. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SUCCESS, @@ -792,7 +863,8 @@ declare namespace relationalStore { * UNKNOWN_ERROR: means the progress meets unknown error. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN_ERROR, @@ -800,7 +872,8 @@ declare namespace relationalStore { * NETWORK_ERROR: means the progress meets network error. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NETWORK_ERROR, @@ -808,7 +881,8 @@ declare namespace relationalStore { * CLOUD_DISABLED: means cloud is disabled. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CLOUD_DISABLED, @@ -816,7 +890,8 @@ declare namespace relationalStore { * LOCKED_BY_OTHERS: means the progress is locked by others. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ LOCKED_BY_OTHERS, @@ -824,7 +899,8 @@ declare namespace relationalStore { * RECORD_LIMIT_EXCEEDED: means the record exceeds the limit. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ RECORD_LIMIT_EXCEEDED, @@ -832,7 +908,8 @@ declare namespace relationalStore { * NO_SPACE_FOR_ASSET: means the cloud has no space for the asset. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NO_SPACE_FOR_ASSET, @@ -840,7 +917,8 @@ declare namespace relationalStore { * BLOCKED_BY_NETWORK_STRATEGY: means the sync blocked by network strategy. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ BLOCKED_BY_NETWORK_STRATEGY } @@ -850,7 +928,8 @@ declare namespace relationalStore { * * @interface ProgressDetails * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ProgressDetails { /** @@ -858,7 +937,8 @@ declare namespace relationalStore { * * @type { Progress } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ schedule: Progress; @@ -867,7 +947,8 @@ declare namespace relationalStore { * * @type { ProgressCode } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ code: ProgressCode; @@ -882,7 +963,8 @@ declare namespace relationalStore { * * @type { Record } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ details: Record; } @@ -892,7 +974,8 @@ declare namespace relationalStore { * * @interface SqlExecutionInfo * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface SqlExecutionInfo { /** @@ -900,45 +983,50 @@ declare namespace relationalStore { * * @type { Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ sql: Array; /** * Total time used for executing the SQL statements, in μs. * - * @type { number } + * @type { long } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - totalTime: number; + totalTime: long; /** * Maximum time allowed to obtain the SQL file handle, in μs. * - * @type { number } + * @type { long } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - waitTime: number; + waitTime: long; /** * Time used to prepare SQL and args, in μs. * - * @type { number } + * @type { long } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - prepareTime: number; + prepareTime: long; /** * Time used to execute the SQL statements, in μs. * - * @type { number } + * @type { long } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - executeTime: number; + executeTime: long; } /** @@ -947,7 +1035,8 @@ declare namespace relationalStore { * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum SecurityLevel { /** @@ -956,7 +1045,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ S1 = 1, @@ -966,7 +1056,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ S2 = 2, @@ -976,7 +1067,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ S3 = 3, @@ -986,7 +1078,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ S4 = 4 } @@ -996,14 +1089,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum SyncMode { /** * Indicates the data is pushed to remote device from local device. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_MODE_PUSH = 0, @@ -1011,7 +1106,8 @@ declare namespace relationalStore { * Indicates the data is pulled from remote device to local device. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_MODE_PULL = 1, @@ -1019,7 +1115,8 @@ declare namespace relationalStore { * Indicates the data is pulled from remote device to local device. * * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_MODE_TIME_FIRST, @@ -1027,7 +1124,8 @@ declare namespace relationalStore { * Indicates force push the native data to the cloud. * * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_MODE_NATIVE_FIRST, @@ -1035,7 +1133,8 @@ declare namespace relationalStore { * Indicates the data is pulled from cloud to local device. * * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SYNC_MODE_CLOUD_FIRST } @@ -1045,14 +1144,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum SubscribeType { /** * Subscription to remote data changes * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SUBSCRIBE_TYPE_REMOTE = 0, @@ -1067,7 +1168,8 @@ declare namespace relationalStore { * Subscription to cloud data changes * * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SUBSCRIBE_TYPE_CLOUD, @@ -1082,7 +1184,8 @@ declare namespace relationalStore { * Subscription to cloud data changes details * * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SUBSCRIBE_TYPE_CLOUD_DETAILS, @@ -1090,7 +1193,8 @@ declare namespace relationalStore { * Subscription to local data changes details * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SUBSCRIBE_TYPE_LOCAL_DETAILS } @@ -1100,7 +1204,8 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ChangeType { /** @@ -1114,7 +1219,8 @@ declare namespace relationalStore { * Means the change type is data change. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DATA_CHANGE, @@ -1129,7 +1235,8 @@ declare namespace relationalStore { * Means the change type is asset change. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASSET_CHANGE } @@ -1139,7 +1246,8 @@ declare namespace relationalStore { * * @interface ChangeInfo * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ChangeInfo { /** @@ -1147,7 +1255,8 @@ declare namespace relationalStore { * * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ table: string; @@ -1156,7 +1265,8 @@ declare namespace relationalStore { * * @type { ChangeType } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ChangeType; @@ -1164,31 +1274,34 @@ declare namespace relationalStore { * Indicates if there is a string primary key, the inserted will keep data's primary keys * otherwise it will keep the data's rowid. * - * @type { Array | Array } + * @type { Array | Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - inserted: Array | Array; + inserted: Array | Array; /** * Indicates if there is a string primary key, the updated will keep data's primary keys * otherwise it will keep the data's rowid. * - * @type { Array | Array } + * @type { Array | Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - updated: Array | Array; + updated: Array | Array; /** * Indicates if there is a string primary key, the deleted will keep data's primary keys * otherwise it will keep the data's rowid. * - * @type { Array | Array } + * @type { Array | Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - deleted: Array | Array; + deleted: Array | Array; } /** @@ -1196,14 +1309,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum DistributedType { /** * Indicates the table is distributed among the devices * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ DISTRIBUTED_DEVICE, @@ -1218,7 +1333,8 @@ declare namespace relationalStore { * Indicates the table is distributed between the cloud and the devices. * * @syscap SystemCapability.DistributedDataManager.CloudSync.Client - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DISTRIBUTED_CLOUD } @@ -1229,7 +1345,8 @@ declare namespace relationalStore { * @interface Reference * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Reference { /** @@ -1238,7 +1355,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ sourceTable: string; @@ -1248,7 +1366,8 @@ declare namespace relationalStore { * @type { string } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ targetTable: string; @@ -1258,7 +1377,8 @@ declare namespace relationalStore { * @type { Record } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ refFields: Record } @@ -1268,7 +1388,8 @@ declare namespace relationalStore { * * @interface DistributedConfig * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DistributedConfig { /** @@ -1276,7 +1397,8 @@ declare namespace relationalStore { * * @type { boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ autoSync: boolean; @@ -1286,7 +1408,8 @@ declare namespace relationalStore { * @type { ?Array } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ references?: Array; @@ -1315,7 +1438,8 @@ declare namespace relationalStore { * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum ConflictResolution { /** @@ -1323,7 +1447,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_CONFLICT_NONE = 0, @@ -1332,7 +1457,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_CONFLICT_ROLLBACK = 1, @@ -1341,7 +1467,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_CONFLICT_ABORT = 2, @@ -1350,7 +1477,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_CONFLICT_FAIL = 3, @@ -1359,7 +1487,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_CONFLICT_IGNORE = 4, @@ -1368,7 +1497,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ ON_CONFLICT_REPLACE = 5 } @@ -1478,14 +1608,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum RebuildType { /** * The database is not rebuilt or repaired. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE, @@ -1493,7 +1625,8 @@ declare namespace relationalStore { * The database is rebuilt. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REBUILT, @@ -1501,7 +1634,8 @@ declare namespace relationalStore { * The database is repaired. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REPAIRED } @@ -1511,14 +1645,16 @@ declare namespace relationalStore { * * @enum { number } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ enum TransactionType { /** * The DEFERRED transaction. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ DEFERRED, @@ -1526,7 +1662,8 @@ declare namespace relationalStore { * The IMMEDIATE transaction. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ IMMEDIATE, @@ -1534,7 +1671,8 @@ declare namespace relationalStore { * The EXCLUSIVE transaction. * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ EXCLUSIVE } @@ -1544,7 +1682,8 @@ declare namespace relationalStore { * * @interface TransactionOptions * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ interface TransactionOptions { /** @@ -1552,7 +1691,8 @@ declare namespace relationalStore { * * @type { TransactionType } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ transactionType?: TransactionType; } @@ -1661,7 +1801,8 @@ declare namespace relationalStore { * * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ class RdbPredicates { /** @@ -1681,7 +1822,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(name: string); @@ -1694,7 +1836,8 @@ declare namespace relationalStore { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ inDevices(devices: Array): RdbPredicates; @@ -1704,7 +1847,8 @@ declare namespace relationalStore { * * @returns { RdbPredicates } - The {@link RdbPredicates} self. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ inAllDevices(): RdbPredicates; @@ -1733,7 +1877,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ equalTo(field: string, value: ValueType): RdbPredicates; @@ -1762,7 +1907,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ notEqualTo(field: string, value: ValueType): RdbPredicates; @@ -1781,7 +1927,8 @@ declare namespace relationalStore { * @returns { RdbPredicates } - The {@link RdbPredicates} with the left parenthesis. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ beginWrap(): RdbPredicates; @@ -1800,7 +1947,8 @@ declare namespace relationalStore { * @returns { RdbPredicates } - The {@link RdbPredicates} with the right parenthesis. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ endWrap(): RdbPredicates; @@ -1819,7 +1967,8 @@ declare namespace relationalStore { * @returns { RdbPredicates } - The {@link RdbPredicates} with the or condition. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ or(): RdbPredicates; @@ -1838,7 +1987,8 @@ declare namespace relationalStore { * @returns { RdbPredicates } - The {@link RdbPredicates} with the and condition. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ and(): RdbPredicates; @@ -1867,7 +2017,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ contains(field: string, value: string): RdbPredicates; @@ -1896,7 +2047,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ beginsWith(field: string, value: string): RdbPredicates; @@ -1925,7 +2077,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ endsWith(field: string, value: string): RdbPredicates; @@ -1950,7 +2103,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isNull(field: string): RdbPredicates; @@ -1975,7 +2129,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isNotNull(field: string): RdbPredicates; @@ -2004,7 +2159,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ like(field: string, value: string): RdbPredicates; @@ -2033,7 +2189,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ glob(field: string, value: string): RdbPredicates; @@ -2060,7 +2217,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ between(field: string, low: ValueType, high: ValueType): RdbPredicates; @@ -2087,7 +2245,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates; @@ -2112,7 +2271,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ greaterThan(field: string, value: ValueType): RdbPredicates; @@ -2137,7 +2297,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ lessThan(field: string, value: ValueType): RdbPredicates; @@ -2162,7 +2323,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates; @@ -2187,7 +2349,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates; @@ -2212,7 +2375,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ orderByAsc(field: string): RdbPredicates; @@ -2237,7 +2401,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ orderByDesc(field: string): RdbPredicates; @@ -2254,14 +2419,15 @@ declare namespace relationalStore { * @returns { RdbPredicates } - The SQL query statement with the specified {@link RdbPredicates}. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ distinct(): RdbPredicates; /** * Restricts the max number of return records. * - * @param { number } value - Indicates the max length of the return list. + * @param { int } value - Indicates the max length of the return list. * @returns { RdbPredicates } - The SQL query statement with the specified {@link RdbPredicates}. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -2271,21 +2437,22 @@ declare namespace relationalStore { /** * Restricts the max number of return records. * - * @param { number } value - Indicates the max length of the return list. + * @param { int } value - Indicates the max length of the return list. * @returns { RdbPredicates } - The SQL query statement with the specified {@link RdbPredicates}. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - limitAs(value: number): RdbPredicates; + limitAs(value: int): RdbPredicates; /** * Configure RdbPredicates to specify the start position of the returned result. * Use this method together with limit(number). * - * @param { number } rowOffset - Indicates the start position of the returned result. The value is a positive integer. + * @param { int } rowOffset - Indicates the start position of the returned result. The value is a positive integer. * @returns { RdbPredicates } - The SQL query statement with the specified {@link RdbPredicates}. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -2296,15 +2463,16 @@ declare namespace relationalStore { * Configure RdbPredicates to specify the start position of the returned result. * Use this method together with limit(number). * - * @param { number } rowOffset - Indicates the start position of the returned result. The value is a positive integer. + * @param { int } rowOffset - Indicates the start position of the returned result. The value is a positive integer. * @returns { RdbPredicates } - The SQL query statement with the specified {@link RdbPredicates}. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - offsetAs(rowOffset: number): RdbPredicates; + offsetAs(rowOffset: int): RdbPredicates; /** * Configure RdbPredicates to group query results by specified columns. @@ -2325,7 +2493,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ groupBy(fields: Array): RdbPredicates; @@ -2350,7 +2519,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ indexedBy(field: string): RdbPredicates; @@ -2377,7 +2547,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ in(field: string, value: Array): RdbPredicates; @@ -2404,7 +2575,8 @@ declare namespace relationalStore { *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ notIn(field: string, value: Array): RdbPredicates; @@ -2419,7 +2591,8 @@ declare namespace relationalStore { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ notContains(field: string, value: string): RdbPredicates; @@ -2434,7 +2607,8 @@ declare namespace relationalStore { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ notLike(field: string, value: string): RdbPredicates; } @@ -2452,7 +2626,8 @@ declare namespace relationalStore { * @interface ResultSet * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ResultSet { /** @@ -2488,12 +2663,13 @@ declare namespace relationalStore { * The returned number is equal to the length of the string array returned by the * columnNames method. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - columnCount: number; + columnCount: int; /** * Obtains the number of rows in the result set. @@ -2504,12 +2680,13 @@ declare namespace relationalStore { /** * Obtains the number of rows in the result set. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - rowCount: number; + rowCount: int; /** * Obtains the current index of the result set. @@ -2522,12 +2699,13 @@ declare namespace relationalStore { * Obtains the current index of the result set. * The result set index starts from 0. * - * @type { number } + * @type { int } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - rowIndex: number; + rowIndex: int; /** * Checks whether the cursor is positioned at the first row. @@ -2541,7 +2719,8 @@ declare namespace relationalStore { * @type { boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isAtFirstRow: boolean; @@ -2557,7 +2736,8 @@ declare namespace relationalStore { * @type { boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isAtLastRow: boolean; @@ -2573,7 +2753,8 @@ declare namespace relationalStore { * @type { boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isEnded: boolean; @@ -2589,7 +2770,8 @@ declare namespace relationalStore { * @type { boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isStarted: boolean; @@ -2607,7 +2789,8 @@ declare namespace relationalStore { * @type { boolean } * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isClosed: boolean; @@ -2616,7 +2799,7 @@ declare namespace relationalStore { * The column name is passed as an input parameter. * * @param { string } columnName - Indicates the name of the specified column in the result set. - * @returns { number } The index of the specified column. + * @returns { int } The index of the specified column. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -2628,7 +2811,7 @@ declare namespace relationalStore { * The column name is passed as an input parameter. * * @param { string } columnName - Indicates the name of the specified column in the result set. - * @returns { number } The index of the specified column. + * @returns { int } The index of the specified column. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -2641,7 +2824,7 @@ declare namespace relationalStore { * The column name is passed as an input parameter. * * @param { string } columnName - Indicates the name of the specified column in the result set. - * @returns { number } The index of the specified column. + * @returns { int } The index of the specified column. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -2665,15 +2848,16 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getColumnIndex(columnName: string): number; + getColumnIndex(columnName: string): int; /** * Obtains the column name based on the specified column index. * The column index is passed as an input parameter. * - * @param { number } columnIndex - Indicates the index of the specified column in the result set. + * @param { int } columnIndex - Indicates the index of the specified column in the result set. * @returns { string } The name of the specified column. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -2685,7 +2869,7 @@ declare namespace relationalStore { * Obtains the column name based on the specified column index. * The column index is passed as an input parameter. * - * @param { number } columnIndex - Indicates the index of the specified column in the result set. + * @param { int } columnIndex - Indicates the index of the specified column in the result set. * @returns { string } The name of the specified column. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -2698,7 +2882,7 @@ declare namespace relationalStore { * Obtains the column name based on the specified column index. * The column index is passed as an input parameter. * - * @param { number } columnIndex - Indicates the index of the specified column in the result set. + * @param { int } columnIndex - Indicates the index of the specified column in the result set. * @returns { string } The name of the specified column. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -2723,9 +2907,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getColumnName(columnIndex: number): string; + getColumnName(columnIndex: int): string; /** * Obtains the column data type based on the specified column index. @@ -2799,7 +2984,7 @@ declare namespace relationalStore { * Go to the specified row of the result set forwards or backwards by an offset relative to its current position. * A positive offset indicates moving backwards, and a negative offset indicates moving forwards. * - * @param { number } offset - Indicates the offset relative to the current position. + * @param { int } offset - Indicates the offset relative to the current position. * @returns { boolean } True if the result set is moved successfully and does not go beyond the range; * Returns false otherwise. * @throws { BusinessError } 14800012 - The result set is empty or the specified location is invalid. @@ -2812,7 +2997,7 @@ declare namespace relationalStore { * Go to the specified row of the result set forwards or backwards by an offset relative to its current position. * A positive offset indicates moving backwards, and a negative offset indicates moving forwards. * - * @param { number } offset - Indicates the offset relative to the current position. + * @param { int } offset - Indicates the offset relative to the current position. * @returns { boolean } True if the result set is moved successfully and does not go beyond the range; * Returns false otherwise. * @throws { BusinessError } 14800012 - The result set is empty or the specified location is invalid. @@ -2826,7 +3011,7 @@ declare namespace relationalStore { * Go to the specified row of the result set forwards or backwards by an offset relative to its current position. * A positive offset indicates moving backwards, and a negative offset indicates moving forwards. * - * @param { number } offset - Indicates the offset relative to the current position. + * @param { int } offset - Indicates the offset relative to the current position. * @returns { boolean } True if the result set is moved successfully and does not go beyond the range; * Returns false otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -2852,14 +3037,15 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - goTo(offset: number): boolean; + goTo(offset: int): boolean; /** * Go to the specified row of the result set. * - * @param { number } position - Indicates the index of the specified row, which starts from 0. + * @param { int } position - Indicates the index of the specified row, which starts from 0. * @returns { boolean } True if the result set is moved successfully; Returns false otherwise. * @throws { BusinessError } 14800012 - The result set is empty or the specified location is invalid. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -2870,7 +3056,7 @@ declare namespace relationalStore { /** * Go to the specified row of the result set. * - * @param { number } position - Indicates the index of the specified row, which starts from 0. + * @param { int } position - Indicates the index of the specified row, which starts from 0. * @returns { boolean } True if the result set is moved successfully; Returns false otherwise. * @throws { BusinessError } 14800012 - The result set is empty or the specified location is invalid. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -2882,7 +3068,7 @@ declare namespace relationalStore { /** * Go to the specified row of the result set. * - * @param { number } position - Indicates the index of the specified row, which starts from 0. + * @param { int } position - Indicates the index of the specified row, which starts from 0. * @returns { boolean } True if the result set is moved successfully; Returns false otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -2907,9 +3093,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - goToRow(position: number): boolean; + goToRow(position: int): boolean; /** * Go to the first row of the result set. @@ -2956,7 +3143,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ goToFirstRow(): boolean; @@ -3005,7 +3193,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ goToLastRow(): boolean; @@ -3054,7 +3243,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ goToNextRow(): boolean; @@ -3103,7 +3293,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ goToPreviousRow(): boolean; @@ -3112,7 +3303,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Blob type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Uint8Array } The value of the specified column as a byte array. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3125,7 +3316,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Blob type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Uint8Array } The value of the specified column as a byte array. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3139,7 +3330,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Blob type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Uint8Array } The value of the specified column as a byte array. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3164,16 +3355,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getBlob(columnIndex: number): Uint8Array; + getBlob(columnIndex: int): Uint8Array; /** * Obtains the value of the specified column in the current row as string. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the string type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { string } The value of the specified column as a string. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3186,7 +3378,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the string type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { string } The value of the specified column as a string. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3200,7 +3392,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the string type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { string } The value of the specified column as a string. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3225,17 +3417,18 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getString(columnIndex: number): string; + getString(columnIndex: int): string; /** * Obtains the value of the specified column in the current row as long. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the integer type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. - * @returns { number } The value of the specified column as a long. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. + * @returns { long } The value of the specified column as a long. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3247,8 +3440,8 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the integer type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. - * @returns { number } The value of the specified column as a long. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. + * @returns { long } The value of the specified column as a long. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3261,8 +3454,8 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the integer type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. - * @returns { number } The value of the specified column as a long. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. + * @returns { long } The value of the specified column as a long. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3286,17 +3479,18 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getLong(columnIndex: number): number; + getLong(columnIndex: int): long; /** * Obtains the value of the specified column in the current row as double. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the double type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. - * @returns { number } The value of the specified column as a double. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. + * @returns { double } The value of the specified column as a double. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3308,8 +3502,8 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the double type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. - * @returns { number } The value of the specified column as a double. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. + * @returns { double } The value of the specified column as a double. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3322,8 +3516,8 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null, the specified column is not of the double type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. - * @returns { number } The value of the specified column as a double. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. + * @returns { double } The value of the specified column as a double. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3347,16 +3541,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getDouble(columnIndex: number): number; + getDouble(columnIndex: int): double; /** * Obtains the value of the specified column in the current row as an asset. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Asset type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Asset } The value of the specified column as an asset. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3370,7 +3565,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Asset type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Asset } The value of the specified column as an asset. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3395,16 +3590,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getAsset(columnIndex: number): Asset; + getAsset(columnIndex: int): Asset; /** * Obtains the value of the specified column in the current row as assets. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Assets type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Assets } The value of the specified column as assets. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3418,7 +3614,7 @@ declare namespace relationalStore { * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Assets type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Assets } The value of the specified column as assets. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3443,16 +3639,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getAssets(columnIndex: number): Assets; + getAssets(columnIndex: int): Assets; /** * Obtains the value of the specified column in the current row. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the Assets type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { ValueType } The value of the specified column. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3485,7 +3682,7 @@ declare namespace relationalStore { * Inserting an empty blob, after API14 and API14, the obtained value is an empty blob; Before API 14, * the obtained value was null. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { ValueType } The value of the specified column. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3509,17 +3706,19 @@ declare namespace relationalStore { * @throws { BusinessError } 14800033 - SQLite: Data type mismatch. * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - getValue(columnIndex: number): ValueType; + getValue(columnIndex: int): ValueType; /** * Obtains the value of the specified column in the current row as a float array. * The implementation class determines whether to throw an exception if the value of the specified column * in the current row is null or the specified column is not of the float array type. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { Float32Array } The value of the specified column as a float array. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 801 - The capability is not supported because the database is not a vector DB. @@ -3542,9 +3741,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - getFloat32Array(columnIndex: number): Float32Array; + getFloat32Array(columnIndex: int): Float32Array; /** * Obtains the values of all columns in the specified row. @@ -3609,7 +3809,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getRow(): ValuesBucket; @@ -3674,7 +3875,7 @@ declare namespace relationalStore { /** * Checks whether the value of the specified column in the current row is null. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { boolean } True if the value of the specified column in the current row is null; * Returns false otherwise. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. @@ -3686,7 +3887,7 @@ declare namespace relationalStore { /** * Checks whether the value of the specified column in the current row is null. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { boolean } True if the value of the specified column in the current row is null; * Returns false otherwise. * @throws { BusinessError } 14800013 - The column value is null or the column type is incompatible. @@ -3699,7 +3900,7 @@ declare namespace relationalStore { /** * Checks whether the value of the specified column in the current row is null. * - * @param { number } columnIndex - Indicates the specified column index, which starts from 0. + * @param { int } columnIndex - Indicates the specified column index, which starts from 0. * @returns { boolean } True if the value of the specified column in the current row is null; * Returns false otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; @@ -3725,9 +3926,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - isColumnNull(columnIndex: number): boolean; + isColumnNull(columnIndex: int): boolean; /** * Closes the result set. @@ -3754,7 +3956,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800012 - Row out of bounds. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; } @@ -3774,7 +3977,8 @@ declare namespace relationalStore { * @interface RdbStore * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ interface RdbStore { /** @@ -3800,7 +4004,7 @@ declare namespace relationalStore { * Set RdbStore version. The version number must be an integer greater than 0. * Obtains the RdbStore version. * - * @type { number } + * @type { int } * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 801 - Capability not supported. @@ -3818,9 +4022,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800030 - SQLite: Unable to open the database file. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - version: number; + version: int; /** * Set whether the database is rebuilt. @@ -3836,7 +4041,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. - * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3848,7 +4053,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. - * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3862,7 +4067,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. - * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3886,9 +4091,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - insert(table: string, values: ValuesBucket, callback: AsyncCallback): void; + insert(table: string, values: ValuesBucket, callback: AsyncCallback): void; /** * Inserts a row of data into the target table. @@ -3896,7 +4102,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3911,7 +4117,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The row ID if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3935,16 +4141,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - insert(table: string, values: ValuesBucket, conflict: ConflictResolution, callback: AsyncCallback): void; + insert(table: string, values: ValuesBucket, conflict: ConflictResolution, callback: AsyncCallback): void; /** * Inserts a row of data into the target table. * * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. + * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3956,7 +4163,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. + * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -3970,7 +4177,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. + * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -3994,9 +4201,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - insert(table: string, values: ValuesBucket): Promise; + insert(table: string, values: ValuesBucket): Promise; /** * Inserts a row of data into the target table. @@ -4004,7 +4212,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. + * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4019,7 +4227,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. + * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4043,9 +4251,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - insert(table: string, values: ValuesBucket, conflict: ConflictResolution): Promise; + insert(table: string, values: ValuesBucket, conflict: ConflictResolution): Promise; /** * Inserts a row of data into the target table with sync interface. @@ -4053,7 +4262,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { number } The row ID if the operation is successful. return -1 otherwise. + * @returns { long } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4077,9 +4286,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - insertSync(table: string, values: ValuesBucket, conflict?: ConflictResolution): number; + insertSync(table: string, values: ValuesBucket, conflict?: ConflictResolution): long; /** * Inserts a row of data into the target table with sync interface. @@ -4120,7 +4330,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @param { AsyncCallback } callback - The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4132,7 +4342,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @param { AsyncCallback } callback - The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4146,7 +4356,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @param { AsyncCallback } callback - The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @param { AsyncCallback } callback - The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4170,16 +4380,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsert(table: string, values: Array, callback: AsyncCallback): void; + batchInsert(table: string, values: Array, callback: AsyncCallback): void; /** * Inserts a batch of data into the target table. * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4191,7 +4402,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4205,7 +4416,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4229,16 +4440,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsert(table: string, values: Array): Promise; + batchInsert(table: string, values: Array): Promise; /** * Inserts a batch of data into the target table. * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { number } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { long } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4262,9 +4474,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsertSync(table: string, values: Array): number; + batchInsertSync(table: string, values: Array): long; /** * Inserts a batch of data into the target table. @@ -4272,7 +4485,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4296,16 +4509,18 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsertWithConflictResolution(table: string, values: Array, conflict: ConflictResolution): Promise; + batchInsertWithConflictResolution(table: string, values: Array, conflict: ConflictResolution): Promise; /** * Inserts a batch of data into the target table. * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { number } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. + * @returns { long } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4329,9 +4544,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsertWithConflictResolutionSync(table: string, values: Array, conflict: ConflictResolution): number; + batchInsertWithConflictResolutionSync(table: string, values: Array, conflict: ConflictResolution): long; /** * Updates data in the database based on a specified instance object of RdbPredicates. @@ -4339,7 +4555,7 @@ declare namespace relationalStore { * @param { ValuesBucket } values - Indicates the row of data to be updated in the database. * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4352,7 +4568,7 @@ declare namespace relationalStore { * @param { ValuesBucket } values - Indicates the row of data to be updated in the database. * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4367,7 +4583,7 @@ declare namespace relationalStore { * @param { ValuesBucket } values - Indicates the row of data to be updated in the database. * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4391,9 +4607,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback): void; + update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback): void; /** * Updates data in the database based on a specified instance object of RdbPredicates. @@ -4402,7 +4619,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4418,7 +4635,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4442,13 +4659,14 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ update( values: ValuesBucket, predicates: RdbPredicates, conflict: ConflictResolution, - callback: AsyncCallback + callback: AsyncCallback ): void; /** @@ -4457,7 +4675,7 @@ declare namespace relationalStore { * @param { ValuesBucket } values - Indicates the row of data to be updated in the database. * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. - * @returns { Promise } The number of affected rows. + * @returns { Promise } The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4470,7 +4688,7 @@ declare namespace relationalStore { * @param { ValuesBucket } values - Indicates the row of data to be updated in the database. * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. - * @returns { Promise } The number of affected rows. + * @returns { Promise } The number of affected rows. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4485,7 +4703,7 @@ declare namespace relationalStore { * @param { ValuesBucket } values - Indicates the row of data to be updated in the database. * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. - * @returns { Promise } The number of affected rows. + * @returns { Promise } The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4509,9 +4727,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - update(values: ValuesBucket, predicates: RdbPredicates): Promise; + update(values: ValuesBucket, predicates: RdbPredicates): Promise; /** * Updates data in the database based on a specified instance object of RdbPredicates. @@ -4520,7 +4739,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The number of affected rows. + * @returns { Promise } The number of affected rows. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4536,7 +4755,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The number of affected rows. + * @returns { Promise } The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4560,9 +4779,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - update(values: ValuesBucket, predicates: RdbPredicates, conflict: ConflictResolution): Promise; + update(values: ValuesBucket, predicates: RdbPredicates, conflict: ConflictResolution): Promise; /** * Updates data in the database based on a specified instance object of RdbPredicates with sync interface. @@ -4571,7 +4791,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { number } The number of affected rows. + * @returns { long } The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4595,9 +4815,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - updateSync(values: ValuesBucket, predicates: RdbPredicates, conflict?: ConflictResolution): number; + updateSync(values: ValuesBucket, predicates: RdbPredicates, conflict?: ConflictResolution): long; /** * Updates data in the database based on a specified instance object of RdbPredicates. @@ -4758,7 +4979,7 @@ declare namespace relationalStore { * Deletes data from the database based on a specified instance object of RdbPredicates. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4769,7 +4990,7 @@ declare namespace relationalStore { * Deletes data from the database based on a specified instance object of RdbPredicates. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4782,7 +5003,7 @@ declare namespace relationalStore { * Deletes data from the database based on a specified instance object of RdbPredicates. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @param { AsyncCallback } callback - The number of affected rows. + * @param { AsyncCallback } callback - The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4806,9 +5027,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - delete(predicates: RdbPredicates, callback: AsyncCallback): void; + delete(predicates: RdbPredicates, callback: AsyncCallback): void; /** * Deletes data from the database based on a specified instance object of RdbPredicates. @@ -4825,7 +5047,7 @@ declare namespace relationalStore { * Deletes data from the database based on a specified instance object of RdbPredicates. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @returns { Promise } return the number of affected rows. + * @returns { Promise } return the number of affected rows. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -4838,7 +5060,7 @@ declare namespace relationalStore { * Deletes data from the database based on a specified instance object of RdbPredicates. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @returns { Promise } return the number of affected rows. + * @returns { Promise } return the number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4862,15 +5084,16 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - delete(predicates: RdbPredicates): Promise; + delete(predicates: RdbPredicates): Promise; /** * Deletes data from the database based on a specified instance object of RdbPredicates with sync interface. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @returns { number } return the number of affected rows. + * @returns { long } return the number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -4894,9 +5117,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - deleteSync(predicates: RdbPredicates): number; + deleteSync(predicates: RdbPredicates): long; /** * Deletes data from the database based on a specified instance object of RdbPredicates. * @@ -4962,7 +5186,8 @@ declare namespace relationalStore { * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi * @StageModelOnly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback): void; @@ -5031,7 +5256,8 @@ declare namespace relationalStore { * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi * @StageModelOnly - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ delete(table: string, predicates: dataSharePredicates.DataSharePredicates): Promise; @@ -5059,7 +5285,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ query(predicates: RdbPredicates, callback: AsyncCallback): void; @@ -5101,7 +5328,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ query(predicates: RdbPredicates, columns: Array, callback: AsyncCallback): void; @@ -5143,7 +5371,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ query(predicates: RdbPredicates, columns?: Array): Promise; @@ -5281,7 +5510,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ querySync(predicates: RdbPredicates, columns?: Array): ResultSet; @@ -5309,7 +5539,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ querySql(sql: string, callback: AsyncCallback): void; @@ -5351,7 +5582,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ querySql(sql: string, bindArgs: Array, callback: AsyncCallback): void; @@ -5393,7 +5625,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ querySql(sql: string, bindArgs?: Array): Promise; @@ -5410,7 +5643,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800015 - The database does not respond. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ querySqlSync(sql: string, bindArgs?: Array): ResultSet; @@ -5847,7 +6081,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ executeSql(sql: string, callback: AsyncCallback): void; @@ -5907,7 +6142,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ executeSql(sql: string, bindArgs: Array, callback: AsyncCallback): void; @@ -5967,7 +6203,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ executeSql(sql: string, bindArgs?: Array): Promise; @@ -6000,7 +6237,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ execute(sql: string, args?: Array): Promise; @@ -6034,7 +6272,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ execute(sql: string, txId: number, args?: Array): Promise; @@ -6067,7 +6306,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ executeSync(sql: string, args?: Array): ValueType; @@ -6114,7 +6354,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ beginTransaction(): void; @@ -6187,14 +6428,15 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ commit(): void; /** * Commits the SQL statement executed. * - * @param { number } txId - Indicates the transaction ID which is obtained by beginTrans. + * @param { long } txId - Indicates the transaction ID which is obtained by beginTrans. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. @@ -6217,9 +6459,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800033 - SQLite: Data type mismatch. * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - commit(txId : number): Promise; + commit(txId : long): Promise; /** * Roll back the sql you have already executed. @@ -6260,14 +6503,15 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ rollBack(): void; /** * Rolls back the SQL statement executed. * - * @param { number } txId - Indicates the transaction ID which is obtained by beginTrans. + * @param { long } txId - Indicates the transaction ID which is obtained by beginTrans. * @returns { Promise } Promise used to return the result. * @throws { BusinessError } 401 - Parameter error. The store must not be nullptr. * @throws { BusinessError } 14800011 - Database corrupted. @@ -6291,7 +6535,7 @@ declare namespace relationalStore { * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @since 12 */ - rollback(txId : number): Promise; + rollback(txId : long): Promise; /** * Backs up a database in a specified name. @@ -6343,7 +6587,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ backup(destName: string, callback: AsyncCallback): void; @@ -6397,7 +6642,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ backup(destName: string): Promise; @@ -6451,7 +6697,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ restore(srcName: string, callback: AsyncCallback): void; @@ -6505,7 +6752,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ restore(srcName: string): Promise; @@ -6535,7 +6783,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800034 - SQLite: Library used incorrectly. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ restore(): Promise; @@ -7416,7 +7665,8 @@ declare namespace relationalStore { * @throws { BusinessError } 401 - Parameter error. The store must not be nullptr. * @throws { BusinessError } 14800000 - Inner error. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ close(): Promise; @@ -7659,7 +7909,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800030 - SQLite: Unable to open the database file. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ createTransaction(options?: TransactionOptions): Promise; } @@ -7670,7 +7921,8 @@ declare namespace relationalStore { * @interface Transaction * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Transaction { /** @@ -7688,7 +7940,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800029 - SQLite: The database is full. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ commit(): Promise; @@ -7707,7 +7960,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800029 - SQLite: The database is full. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ rollback(): Promise; @@ -7717,7 +7971,7 @@ declare namespace relationalStore { * @param { string } table - Indicates the target table. * @param { ValuesBucket } values - Indicates the row of data {@link ValuesBucket} to be inserted into the table. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. + * @returns { Promise } The row ID if the operation is successful. return -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7736,9 +7990,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - insert(table: string, values: ValuesBucket, conflict?: ConflictResolution): Promise; + insert(table: string, values: ValuesBucket, conflict?: ConflictResolution): Promise; /** * Inserts a row of data into the target table with sync interface, just use in TaskPool or Worker. @@ -7774,7 +8029,7 @@ declare namespace relationalStore { * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { Promise } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7793,16 +8048,17 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsert(table: string, values: Array): Promise; + batchInsert(table: string, values: Array): Promise; /** * Inserts a batch of data into the target table. * * @param { string } table - Indicates the target table. * @param { Array } values - Indicates the rows of data {@link ValuesBucket} to be inserted into the table. - * @returns { number } The number of values that were inserted if the operation is successful. returns -1 otherwise. + * @returns { long } The number of values that were inserted if the operation is successful. returns -1 otherwise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7821,9 +8077,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - batchInsertSync(table: string, values: Array): number; + batchInsertSync(table: string, values: Array): long; /** * Inserts a batch of data into the target table. @@ -7896,7 +8153,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { Promise } The number of affected rows. + * @returns { Promise } The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7915,9 +8172,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - update(values: ValuesBucket, predicates: RdbPredicates, conflict?: ConflictResolution): Promise; + update(values: ValuesBucket, predicates: RdbPredicates, conflict?: ConflictResolution): Promise; /** * Updates data in the database based on a specified instance object of RdbPredicates with sync interface. @@ -7926,7 +8184,7 @@ declare namespace relationalStore { * The key-value pairs are associated with column names of the database table. * @param { RdbPredicates } predicates - Indicates the specified update condition by the instance object of {@link RdbPredicates}. * @param { ConflictResolution } conflict - Indicates the {@link ConflictResolution} to insert data into the table. - * @returns { number } The number of affected rows. + * @returns { long } The number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7945,15 +8203,16 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - updateSync(values: ValuesBucket, predicates: RdbPredicates, conflict?: ConflictResolution): number; + updateSync(values: ValuesBucket, predicates: RdbPredicates, conflict?: ConflictResolution): long; /** * Deletes data from the database based on a specified instance object of RdbPredicates. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @returns { Promise } return the number of affected rows. + * @returns { Promise } return the number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7972,15 +8231,16 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - delete(predicates: RdbPredicates): Promise; + delete(predicates: RdbPredicates): Promise; /** * Deletes data from the database based on a specified instance object of RdbPredicates with sync interface. * * @param { RdbPredicates } predicates - The specified delete condition by the instance object of {@link RdbPredicates}. - * @returns { number } return the number of affected rows. + * @returns { long } return the number of affected rows. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @throws { BusinessError } 14800000 - Inner error. @@ -7999,9 +8259,10 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - deleteSync(predicates: RdbPredicates): number; + deleteSync(predicates: RdbPredicates): long; /** * Queries data in the database based on specified conditions. @@ -8022,7 +8283,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ query(predicates: RdbPredicates, columns?: Array): Promise; @@ -8046,7 +8308,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ querySync(predicates: RdbPredicates, columns?: Array): ResultSet; @@ -8070,7 +8333,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ querySql(sql: string, args?: Array): Promise; @@ -8094,7 +8358,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ querySqlSync(sql: string, args?: Array): ResultSet; @@ -8122,7 +8387,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800033 - SQLite: Data type mismatch. * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ execute(sql: string, args?: Array): Promise; @@ -8151,7 +8417,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800047 - The WAL file size exceeds the default limit. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ executeSync(sql: string, args?: Array): ValueType; } @@ -8244,7 +8511,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800030 - SQLite: Unable to open the database file. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback): void; @@ -8334,7 +8602,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800030 - SQLite: Unable to open the database file. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function getRdbStore(context: Context, config: StoreConfig): Promise; @@ -8365,7 +8634,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800010 - Failed to open or delete database by invalid database path. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteRdbStore(context: Context, name: string, callback: AsyncCallback): void; @@ -8384,7 +8654,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14801002 - Invalid data group ID. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback): void; @@ -8430,7 +8701,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14800010 - Invalid database path. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteRdbStore(context: Context, name: string): Promise; @@ -8467,7 +8739,8 @@ declare namespace relationalStore { * @throws { BusinessError } 14801002 - Invalid data group ID. * @syscap SystemCapability.DistributedDataManager.RelationalStore.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function deleteRdbStore(context: Context, config: StoreConfig): Promise; diff --git a/api/@ohos.data.unifiedDataChannel.d.ts b/api/@ohos.data.unifiedDataChannel.d.ts index 387102726442a8856e3a8bb423df8e1a37f562c6..1c353be3b0ce7e92beefddd339774ea15070a5db 100644 --- a/api/@ohos.data.unifiedDataChannel.d.ts +++ b/api/@ohos.data.unifiedDataChannel.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2023-2024 Huawei Device Co., Ltd. + * Copyright (c) 2023-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 @@ -44,7 +44,8 @@ import Want from "./@ohos.app.ability.Want"; * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace unifiedDataChannel { /** @@ -96,7 +97,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ type ValueType = number | string | boolean | image.PixelMap | Want | ArrayBuffer | object | null | undefined; @@ -173,7 +175,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class UnifiedData { /** @@ -204,7 +207,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(record: UnifiedRecord); /** @@ -220,7 +224,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -276,7 +281,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getRecords(): Array; @@ -341,7 +347,8 @@ declare namespace unifiedDataChannel { * * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ class Summary { /** @@ -395,7 +402,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ class UnifiedRecord { /** @@ -437,7 +445,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -464,7 +473,8 @@ declare namespace unifiedDataChannel { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(type: string, value: ValueType); diff --git a/api/@ohos.data.uniformTypeDescriptor.d.ts b/api/@ohos.data.uniformTypeDescriptor.d.ts index ab55b421539c6887da10b8c7127e8953d3ec6841..75c10e1ee6753f45db531a030048584f08e45675 100644 --- a/api/@ohos.data.uniformTypeDescriptor.d.ts +++ b/api/@ohos.data.uniformTypeDescriptor.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2023-2024 Huawei Device Co., Ltd. + * Copyright (c) 2023-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 @@ -40,7 +40,8 @@ * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace uniformTypeDescriptor { /** @@ -65,14 +66,16 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ enum UniformDataType { /** * Base data type for physical hierarchy, which identifies the physical representation of the data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ENTITY = 'general.entity', @@ -80,7 +83,8 @@ declare namespace uniformTypeDescriptor { * Base data type for logical hierarchy, which identifies the logical content representation of the data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OBJECT = 'general.object', @@ -88,7 +92,8 @@ declare namespace uniformTypeDescriptor { * Base data type for mixed object. For example, a PDF file contains both text and special formatting data. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ COMPOSITE_OBJECT = 'general.composite-object', @@ -111,7 +116,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ TEXT = 'general.text', @@ -134,7 +140,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ PLAIN_TEXT = 'general.plain-text', @@ -157,7 +164,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ HTML = 'general.html', @@ -180,7 +188,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ HYPERLINK = 'general.hyperlink', @@ -188,7 +197,8 @@ declare namespace uniformTypeDescriptor { * XML(Extensible Markup Language) data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ XML = 'general.xml', @@ -196,7 +206,8 @@ declare namespace uniformTypeDescriptor { * Xhtml data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ XHTML = 'general.xhtml', @@ -204,7 +215,8 @@ declare namespace uniformTypeDescriptor { * Rss data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RSS = 'general.rss', @@ -212,7 +224,8 @@ declare namespace uniformTypeDescriptor { * Real synchronized multimedia integration language. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SMIL = 'com.real.smil', @@ -220,7 +233,8 @@ declare namespace uniformTypeDescriptor { * Source code data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_CODE = 'general.source-code', @@ -228,7 +242,8 @@ declare namespace uniformTypeDescriptor { * Script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SCRIPT = 'general.script', @@ -236,7 +251,8 @@ declare namespace uniformTypeDescriptor { * Shell script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SHELL_SCRIPT = 'general.shell-script', @@ -244,7 +260,8 @@ declare namespace uniformTypeDescriptor { * C-shell script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CSH_SCRIPT = 'general.csh-script', @@ -252,7 +269,8 @@ declare namespace uniformTypeDescriptor { * Perl script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PERL_SCRIPT = 'general.perl-script', @@ -260,7 +278,8 @@ declare namespace uniformTypeDescriptor { * PHP script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PHP_SCRIPT = 'general.php-script', @@ -268,7 +287,8 @@ declare namespace uniformTypeDescriptor { * Python script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PYTHON_SCRIPT = 'general.python-script', @@ -276,7 +296,8 @@ declare namespace uniformTypeDescriptor { * Ruby script data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ RUBY_SCRIPT = 'general.ruby-script', @@ -284,7 +305,8 @@ declare namespace uniformTypeDescriptor { * TypeScript data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_SCRIPT = 'general.type-script', @@ -292,7 +314,8 @@ declare namespace uniformTypeDescriptor { * JavaScript data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JAVA_SCRIPT = 'general.java-script', @@ -300,7 +323,8 @@ declare namespace uniformTypeDescriptor { * Css data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CSS = 'general.css', @@ -308,7 +332,8 @@ declare namespace uniformTypeDescriptor { * C header data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ C_HEADER = 'general.c-header', @@ -316,7 +341,8 @@ declare namespace uniformTypeDescriptor { * C source code data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ C_SOURCE = 'general.c-source', @@ -324,7 +350,8 @@ declare namespace uniformTypeDescriptor { * C++ header data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ C_PLUS_PLUS_HEADER = 'general.c-plus-plus-header', @@ -332,7 +359,8 @@ declare namespace uniformTypeDescriptor { * C++ source code data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ C_PLUS_PLUS_SOURCE = 'general.c-plus-plus-source', @@ -340,7 +368,8 @@ declare namespace uniformTypeDescriptor { * Java source code data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JAVA_SOURCE = 'general.java-source', @@ -348,7 +377,8 @@ declare namespace uniformTypeDescriptor { * Tex source code data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TEX = 'general.tex', @@ -356,7 +386,8 @@ declare namespace uniformTypeDescriptor { * Markdown format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MARKDOWN = 'general.markdown', @@ -364,7 +395,8 @@ declare namespace uniformTypeDescriptor { * Asc text data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ASC_TEXT = 'general.asc-text', @@ -372,7 +404,8 @@ declare namespace uniformTypeDescriptor { * Rich text data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RICH_TEXT = 'general.rich-text', @@ -380,7 +413,8 @@ declare namespace uniformTypeDescriptor { * Delimited values text data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DELIMITED_VALUES_TEXT = 'general.delimited-values-text', @@ -388,7 +422,8 @@ declare namespace uniformTypeDescriptor { * Comma separated values text data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ COMMA_SEPARATED_VALUES_TEXT = 'general.comma-separated-values-text', @@ -396,7 +431,8 @@ declare namespace uniformTypeDescriptor { * Tab separated values text data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TAB_SEPARATED_VALUES_TEXT = 'general.tab-separated-values-text', @@ -404,7 +440,8 @@ declare namespace uniformTypeDescriptor { * Ebook data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EBOOK = 'general.ebook', @@ -412,7 +449,8 @@ declare namespace uniformTypeDescriptor { * EPUB ebook file format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EPUB = 'general.epub', @@ -420,7 +458,8 @@ declare namespace uniformTypeDescriptor { * AZW ebook file format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AZW = 'com.amazon.azw', @@ -428,7 +467,8 @@ declare namespace uniformTypeDescriptor { * AZW3 ebook file format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AZW3 = 'com.amazon.azw3', @@ -436,7 +476,8 @@ declare namespace uniformTypeDescriptor { * KFX ebook file format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ KFX = 'com.amazon.kfx', @@ -444,7 +485,8 @@ declare namespace uniformTypeDescriptor { * MOBI ebook file format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MOBI = 'com.amazon.mobi', @@ -452,7 +494,8 @@ declare namespace uniformTypeDescriptor { * Media data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA = 'general.media', @@ -475,7 +518,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 'general.image', @@ -483,7 +527,8 @@ declare namespace uniformTypeDescriptor { * JPEG image format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JPEG = 'general.jpeg', @@ -491,7 +536,8 @@ declare namespace uniformTypeDescriptor { * PNG image format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PNG = 'general.png', @@ -499,7 +545,8 @@ declare namespace uniformTypeDescriptor { * Raw image format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ RAW_IMAGE = 'general.raw-image', @@ -507,7 +554,8 @@ declare namespace uniformTypeDescriptor { * TIFF image format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ TIFF = 'general.tiff', @@ -515,7 +563,8 @@ declare namespace uniformTypeDescriptor { * Windows bitmap image data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ BMP = 'com.microsoft.bmp', @@ -523,7 +572,8 @@ declare namespace uniformTypeDescriptor { * Windows icon data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ICO = 'com.microsoft.ico', @@ -531,7 +581,8 @@ declare namespace uniformTypeDescriptor { * Adobe Photoshop document data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PHOTOSHOP_IMAGE = 'com.adobe.photoshop-image', @@ -539,7 +590,8 @@ declare namespace uniformTypeDescriptor { * Adobe Illustrator document data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AI_IMAGE = 'com.adobe.illustrator.ai-image', @@ -547,7 +599,8 @@ declare namespace uniformTypeDescriptor { * Base type for fax images. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FAX = 'general.fax', @@ -555,7 +608,8 @@ declare namespace uniformTypeDescriptor { * J2 jConnect fax file format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ JFX_FAX = 'com.j2.jfx-fax', @@ -563,7 +617,8 @@ declare namespace uniformTypeDescriptor { * The electronic fax document format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EFX_FAX = 'com.js.efx-fax', @@ -571,7 +626,8 @@ declare namespace uniformTypeDescriptor { * X bitmap image. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ XBITMAP_IMAGE = 'general.xbitmap-image', @@ -579,7 +635,8 @@ declare namespace uniformTypeDescriptor { * Gif image format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ GIF = 'general.gif', @@ -587,7 +644,8 @@ declare namespace uniformTypeDescriptor { * Tagged Graphics (TGA), a type of image format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TGA_IMAGE = 'com.truevision.tga-image', @@ -595,7 +653,8 @@ declare namespace uniformTypeDescriptor { * Silicon Graphics image. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SGI_IMAGE = 'com.sgi.sgi-image', @@ -603,7 +662,8 @@ declare namespace uniformTypeDescriptor { * OpenEXR image. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENEXR_IMAGE = 'com.ilm.openexr-image', @@ -611,7 +671,8 @@ declare namespace uniformTypeDescriptor { * FlashPix image. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FLASHPIX_IMAGE = 'com.kodak.flashpix.image', @@ -619,7 +680,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Word data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WORD_DOC = 'com.microsoft.word.doc', @@ -627,7 +689,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Excel data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ EXCEL = 'com.microsoft.excel.xls', @@ -635,7 +698,8 @@ declare namespace uniformTypeDescriptor { * Microsoft PowerPoint presentation data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PPT = 'com.microsoft.powerpoint.ppt', @@ -643,7 +707,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Word dot data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WORD_DOT = 'com.microsoft.word.dot', @@ -651,7 +716,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Powerpoint pps data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ POWERPOINT_PPS = 'com.microsoft.powerpoint.pps', @@ -659,7 +725,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Powerpoint pot data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ POWERPOINT_POT = 'com.microsoft.powerpoint.pot', @@ -667,7 +734,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Excel xlt data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EXCEL_XLT = 'com.microsoft.excel.xlt', @@ -675,7 +743,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Visio vsd data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VISIO_VSD = 'com.microsoft.visio.vsd', @@ -683,7 +752,8 @@ declare namespace uniformTypeDescriptor { * PDF data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PDF = 'com.adobe.pdf', @@ -691,7 +761,8 @@ declare namespace uniformTypeDescriptor { * PostScript data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ POSTSCRIPT = 'com.adobe.postscript', @@ -699,7 +770,8 @@ declare namespace uniformTypeDescriptor { * Encapsulated PostScript data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ENCAPSULATED_POSTSCRIPT = 'com.adobe.encapsulated-postscript', @@ -722,7 +794,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO = 'general.video', @@ -730,7 +803,8 @@ declare namespace uniformTypeDescriptor { * AVI video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AVI = 'general.avi', @@ -738,7 +812,8 @@ declare namespace uniformTypeDescriptor { * MPEG video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MPEG = 'general.mpeg', @@ -746,7 +821,8 @@ declare namespace uniformTypeDescriptor { * MPEG4 video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MPEG4 = 'general.mpeg-4', @@ -754,7 +830,8 @@ declare namespace uniformTypeDescriptor { * 3GPP video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_3GPP = 'general.3gpp', @@ -762,7 +839,8 @@ declare namespace uniformTypeDescriptor { * 3GPP2 video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_3GPP2 = 'general.3gpp2', @@ -770,7 +848,8 @@ declare namespace uniformTypeDescriptor { * Ts video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TS = 'general.ts', @@ -778,7 +857,8 @@ declare namespace uniformTypeDescriptor { * Mpegurl video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MPEGURL_VIDEO = 'general.mpegurl-video', @@ -786,7 +866,8 @@ declare namespace uniformTypeDescriptor { * Windows WM video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WM = 'com.microsoft.windows-media-wm', @@ -794,7 +875,8 @@ declare namespace uniformTypeDescriptor { * Windows WMV video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WMV = 'com.microsoft.windows-media-wmv', @@ -802,7 +884,8 @@ declare namespace uniformTypeDescriptor { * Windows WMP video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WMP = 'com.microsoft.windows-media-wmp', @@ -810,7 +893,8 @@ declare namespace uniformTypeDescriptor { * Windows WVX video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WVX = 'com.microsoft.windows-media-wvx', @@ -818,7 +902,8 @@ declare namespace uniformTypeDescriptor { * Windows WMX video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WMX = 'com.microsoft.windows-media-wmx', @@ -826,7 +911,8 @@ declare namespace uniformTypeDescriptor { * RealMedia. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REALMEDIA = 'com.real.realmedia', @@ -834,7 +920,8 @@ declare namespace uniformTypeDescriptor { * Matroska video format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MATROSKA_VIDEO = 'org.matroska.mkv', @@ -842,7 +929,8 @@ declare namespace uniformTypeDescriptor { * Flash data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FLASH = 'com.adobe.flash', @@ -865,7 +953,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO = 'general.audio', @@ -873,7 +962,8 @@ declare namespace uniformTypeDescriptor { * AAC audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AAC = 'general.aac', @@ -881,7 +971,8 @@ declare namespace uniformTypeDescriptor { * AIFF audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ AIFF = 'general.aiff', @@ -889,7 +980,8 @@ declare namespace uniformTypeDescriptor { * ALAC audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ALAC = 'general.alac', @@ -897,7 +989,8 @@ declare namespace uniformTypeDescriptor { * FLAC audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAC = 'general.flac', @@ -905,7 +998,8 @@ declare namespace uniformTypeDescriptor { * MP3 audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MP3 = 'general.mp3', @@ -913,7 +1007,8 @@ declare namespace uniformTypeDescriptor { * OGG audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OGG = 'general.ogg', @@ -921,7 +1016,8 @@ declare namespace uniformTypeDescriptor { * PCM audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ PCM = 'general.pcm', @@ -929,7 +1025,8 @@ declare namespace uniformTypeDescriptor { * Windows WMA audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WMA = 'com.microsoft.windows-media-wma', @@ -937,7 +1034,8 @@ declare namespace uniformTypeDescriptor { * Waveform audio format data type created by Microsoft. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WAVEFORM_AUDIO = 'com.microsoft.waveform-audio', @@ -945,7 +1043,8 @@ declare namespace uniformTypeDescriptor { * Windows WAX audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WINDOWS_MEDIA_WAX = 'com.microsoft.windows-media-wax', @@ -953,7 +1052,8 @@ declare namespace uniformTypeDescriptor { * Au file format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ AU_AUDIO = 'general.au-audio', @@ -961,7 +1061,8 @@ declare namespace uniformTypeDescriptor { * Audio Interchange File Format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ AIFC_AUDIO = 'general.aifc-audio', @@ -969,7 +1070,8 @@ declare namespace uniformTypeDescriptor { * Mpegurl audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MPEGURL_AUDIO = 'general.mpegurl-audio', @@ -977,7 +1079,8 @@ declare namespace uniformTypeDescriptor { * Mpeg-4 audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MPEG_4_AUDIO = 'general.mpeg-4-audio', @@ -985,7 +1088,8 @@ declare namespace uniformTypeDescriptor { * Mp2 audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MP2 = 'general.mp2', @@ -993,7 +1097,8 @@ declare namespace uniformTypeDescriptor { * Mpeg audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MPEG_AUDIO = 'general.mpeg-audio', @@ -1001,7 +1106,8 @@ declare namespace uniformTypeDescriptor { * Ulaw audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ULAW_AUDIO = 'general.ulaw-audio', @@ -1009,7 +1115,8 @@ declare namespace uniformTypeDescriptor { * Digidesign Sound Designer II audio. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SD2_AUDIO = 'com.digidesign.sd2-audio', @@ -1017,7 +1124,8 @@ declare namespace uniformTypeDescriptor { * RealMedia audio. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ REALAUDIO = 'com.real.realaudio', @@ -1025,7 +1133,8 @@ declare namespace uniformTypeDescriptor { * Matroska audio format data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ MATROSKA_AUDIO = 'org.matroska.mka', @@ -1048,7 +1157,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ FILE = 'general.file', @@ -1056,7 +1166,8 @@ declare namespace uniformTypeDescriptor { * Directory data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTORY = 'general.directory', @@ -1079,7 +1190,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLDER = 'general.folder', @@ -1087,7 +1199,8 @@ declare namespace uniformTypeDescriptor { * Symlink data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SYMLINK = 'general.symlink', @@ -1095,7 +1208,8 @@ declare namespace uniformTypeDescriptor { * Archive file data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ARCHIVE = 'general.archive', @@ -1103,7 +1217,8 @@ declare namespace uniformTypeDescriptor { * Bzip2 archive file data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ BZ2_ARCHIVE = 'general.bz2-archive', @@ -1111,7 +1226,8 @@ declare namespace uniformTypeDescriptor { * Opg archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPG = 'general.opg', @@ -1119,7 +1235,8 @@ declare namespace uniformTypeDescriptor { * Taz archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TAZ_ARCHIVE = 'general.taz-archive', @@ -1127,7 +1244,8 @@ declare namespace uniformTypeDescriptor { * Web archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WEB_ARCHIVE = 'general.web-archive', @@ -1135,7 +1253,8 @@ declare namespace uniformTypeDescriptor { * Disk image archive file data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DISK_IMAGE = 'general.disk-image', @@ -1143,7 +1262,8 @@ declare namespace uniformTypeDescriptor { * Iso data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ISO = 'general.iso', @@ -1151,7 +1271,8 @@ declare namespace uniformTypeDescriptor { * Tar archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ TAR_ARCHIVE = 'general.tar-archive', @@ -1159,7 +1280,8 @@ declare namespace uniformTypeDescriptor { * Zip archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ZIP_ARCHIVE = 'general.zip-archive', @@ -1167,7 +1289,8 @@ declare namespace uniformTypeDescriptor { * Java archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JAVA_ARCHIVE = 'com.sun.java-archive', @@ -1175,7 +1298,8 @@ declare namespace uniformTypeDescriptor { * GNU archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GNU_TAR_ARCHIVE = 'org.gnu.gnu-tar-archive', @@ -1183,7 +1307,8 @@ declare namespace uniformTypeDescriptor { * Gzip archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GNU_ZIP_ARCHIVE = 'org.gnu.gnu-zip-archive', @@ -1191,7 +1316,8 @@ declare namespace uniformTypeDescriptor { * Gzip tar archive data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ GNU_ZIP_TAR_ARCHIVE = 'org.gnu.gnu-zip-tar-archive', @@ -1199,7 +1325,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENXML = 'org.openxmlformats.openxml', @@ -1207,7 +1334,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Document. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WORDPROCESSINGML_DOCUMENT = 'org.openxmlformats.wordprocessingml.document', @@ -1215,7 +1343,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Workbook. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SPREADSHEETML_SHEET = 'org.openxmlformats.spreadsheetml.sheet', @@ -1223,7 +1352,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Presentation. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PRESENTATIONML_PRESENTATION = 'org.openxmlformats.presentationml.presentation', @@ -1231,7 +1361,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Drawingml visio. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DRAWINGML_VISIO = 'org.openxmlformats.drawingml.visio', @@ -1239,7 +1370,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Drawingml template. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DRAWINGML_TEMPLATE = 'org.openxmlformats.drawingml.template', @@ -1247,7 +1379,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Wordprocessingml template. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ WORDPROCESSINGML_TEMPLATE = 'org.openxmlformats.wordprocessingml.template', @@ -1255,7 +1388,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Presentationml template. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PRESENTATIONML_TEMPLATE = 'org.openxmlformats.presentationml.template', @@ -1263,7 +1397,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Presentationml slideshow. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PRESENTATIONML_SLIDESHOW = 'org.openxmlformats.presentationml.slideshow', @@ -1271,7 +1406,8 @@ declare namespace uniformTypeDescriptor { * Office Open XML Spreadsheetml template. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SPREADSHEETML_TEMPLATE = 'org.openxmlformats.spreadsheetml.template', @@ -1279,7 +1415,8 @@ declare namespace uniformTypeDescriptor { * Open Document Format for Office Applications. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENDOCUMENT = 'org.oasis.opendocument', @@ -1287,7 +1424,8 @@ declare namespace uniformTypeDescriptor { * OpenDocument Text. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENDOCUMENT_TEXT = 'org.oasis.opendocument.text', @@ -1295,7 +1433,8 @@ declare namespace uniformTypeDescriptor { * OpenDocument Spreadsheet. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENDOCUMENT_SPREADSHEET = 'org.oasis.opendocument.spreadsheet', @@ -1303,7 +1442,8 @@ declare namespace uniformTypeDescriptor { * OpenDocument Presentation. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENDOCUMENT_PRESENTATION = 'org.oasis.opendocument.presentation', @@ -1311,7 +1451,8 @@ declare namespace uniformTypeDescriptor { * OpenDocument Graphics. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENDOCUMENT_GRAPHICS = 'org.oasis.opendocument.graphics', @@ -1319,7 +1460,8 @@ declare namespace uniformTypeDescriptor { * OpenDocument Formulat. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENDOCUMENT_FORMULA = 'org.oasis.opendocument.formula', @@ -1327,7 +1469,8 @@ declare namespace uniformTypeDescriptor { * Stuffit archive. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ STUFFIT_ARCHIVE = 'com.allume.stuffit-archive', @@ -1335,7 +1478,8 @@ declare namespace uniformTypeDescriptor { * Rar archive. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RAR_ARCHIVE = 'com.rarlab.rar-archive', @@ -1343,7 +1487,8 @@ declare namespace uniformTypeDescriptor { * 7-zip archive. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SEVEN_ZIP_ARCHIVE = 'org.7-zip.7-zip-archive', @@ -1351,7 +1496,8 @@ declare namespace uniformTypeDescriptor { * Calendar data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CALENDAR = 'general.calendar', @@ -1359,7 +1505,8 @@ declare namespace uniformTypeDescriptor { * VCalendar type, a type of calendar format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ VCS = 'general.vcs', @@ -1367,7 +1514,8 @@ declare namespace uniformTypeDescriptor { * ICalendar type, a type of calendar format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ICS = 'general.ics', @@ -1375,7 +1523,8 @@ declare namespace uniformTypeDescriptor { * Contact data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTACT = 'general.contact', @@ -1383,7 +1532,8 @@ declare namespace uniformTypeDescriptor { * Database data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ DATABASE = 'general.database', @@ -1391,7 +1541,8 @@ declare namespace uniformTypeDescriptor { * Message data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MESSAGE = 'general.message', @@ -1399,7 +1550,8 @@ declare namespace uniformTypeDescriptor { * Base type for executable data. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EXECUTABLE = 'general.executable', @@ -1407,7 +1559,8 @@ declare namespace uniformTypeDescriptor { * Microsoft Windows application. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PORTABLE_EXECUTABLE = 'com.microsoft.portable-executable', @@ -1415,7 +1568,8 @@ declare namespace uniformTypeDescriptor { * Java class. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SUN_JAVA_CLASS = 'com.sun.java-class', @@ -1423,7 +1577,8 @@ declare namespace uniformTypeDescriptor { * A file format data type stand for electronic business card. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ VCARD = 'general.vcard', @@ -1431,7 +1586,8 @@ declare namespace uniformTypeDescriptor { * Navigation data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION = 'general.navigation', @@ -1439,7 +1595,8 @@ declare namespace uniformTypeDescriptor { * Location data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ LOCATION = 'general.location', @@ -1447,7 +1604,8 @@ declare namespace uniformTypeDescriptor { * Base type for fonts. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FONT = 'general.font', @@ -1455,7 +1613,8 @@ declare namespace uniformTypeDescriptor { * TrueType font. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TRUETYPE_FONT = 'general.truetype-font', @@ -1463,7 +1622,8 @@ declare namespace uniformTypeDescriptor { * TrueType collection font. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ TRUETYPE_COLLECTION_FONT = 'general.truetype-collection-font', @@ -1471,7 +1631,8 @@ declare namespace uniformTypeDescriptor { * OpenType font. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENTYPE_FONT = 'general.opentype-font', @@ -1479,7 +1640,8 @@ declare namespace uniformTypeDescriptor { * PostScript font. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ POSTSCRIPT_FONT = 'com.adobe.postscript-font', @@ -1487,7 +1649,8 @@ declare namespace uniformTypeDescriptor { * A Printer Font Binary version of Adobe's Type 1. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ POSTSCRIPT_PFB_FONT = 'com.adobe.postscript-pfb-font', @@ -1495,7 +1658,8 @@ declare namespace uniformTypeDescriptor { * Adobe Type 1 font. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ POSTSCRIPT_PFA_FONT = 'com.adobe.postscript-pfa-font', @@ -1510,7 +1674,8 @@ declare namespace uniformTypeDescriptor { * * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_FORM = 'openharmony.form', @@ -1525,7 +1690,8 @@ declare namespace uniformTypeDescriptor { * * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_APP_ITEM = 'openharmony.app-item', @@ -1548,7 +1714,8 @@ declare namespace uniformTypeDescriptor { * @syscap SystemCapability.DistributedDataManager.UDMF.Core * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_PIXEL_MAP = 'openharmony.pixel-map', @@ -1556,7 +1723,8 @@ declare namespace uniformTypeDescriptor { * OpenHarmony system defined atomic service data type(the data is provided and bound to OpenHarmony system). * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_ATOMIC_SERVICE = 'openharmony.atomic-service', @@ -1565,7 +1733,8 @@ declare namespace uniformTypeDescriptor { *
and bound to OpenHarmony system). * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_PACKAGE = 'openharmony.package', @@ -1573,7 +1742,8 @@ declare namespace uniformTypeDescriptor { * OpenHarmony system defined ability package(the data is provided and bound to OpenHarmony system). * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_HAP = 'openharmony.hap', @@ -1581,7 +1751,8 @@ declare namespace uniformTypeDescriptor { * OpenHarmony system AppNotepad data format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_HDOC = 'openharmony.hdoc', @@ -1589,7 +1760,8 @@ declare namespace uniformTypeDescriptor { * OpenHarmony system Notes data format. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_HINOTE = 'openharmony.hinote', @@ -1597,7 +1769,8 @@ declare namespace uniformTypeDescriptor { * OpenHarmony system defined styled string. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_STYLED_STRING = 'openharmony.styled-string', @@ -1605,7 +1778,8 @@ declare namespace uniformTypeDescriptor { * OpenHarmony system defined Want. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OPENHARMONY_WANT = 'openharmony.want', @@ -1613,7 +1787,8 @@ declare namespace uniformTypeDescriptor { * Ofd data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OFD = 'general.ofd', @@ -1621,7 +1796,8 @@ declare namespace uniformTypeDescriptor { * Cad data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CAD = 'general.cad', @@ -1629,7 +1805,8 @@ declare namespace uniformTypeDescriptor { * Octet stream data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OCTET_STREAM = 'general.octet-stream', @@ -1637,7 +1814,8 @@ declare namespace uniformTypeDescriptor { * File uri data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FILE_URI = 'general.file-uri', @@ -1645,7 +1823,8 @@ declare namespace uniformTypeDescriptor { * Content form data type. * * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_FORM = 'general.content-form' } @@ -1800,7 +1979,8 @@ declare namespace uniformTypeDescriptor { * @throws { BusinessError } 401 - Parameter error. Possible causes:1.Mandatory parameters are left unspecified; *
2.Incorrect parameters types. * @syscap SystemCapability.DistributedDataManager.UDMF.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUniformDataTypeByFilenameExtension(filenameExtension: string, belongsTo?: string): string; diff --git a/api/@ohos.deviceInfo.d.ets b/api/@ohos.deviceInfo.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..0977a33736dda8f1a6e65df7a2010dcb2aa37f10 --- /dev/null +++ b/api/@ohos.deviceInfo.d.ets @@ -0,0 +1,445 @@ +/* + * Copyright (c) 2021 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 + */ + +/** + * A static class pertaining to the product information. + * + * @namespace deviceInfo + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @atomicservice + * @since 20 + */ +declare class deviceInfo { + + /** + * Obtains the device type represented by a string, + * which can be {@code phone} (or {@code default} for phones), {@code wearable}, {@code liteWearable}, + * {@code tablet}, {@code tv}, {@code car}, or {@code smartVision}. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @atomicservice + * @since 20 + */ + static get deviceType(): string; + + /** + * Obtains the device manufacturer represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get manufacture(): string; + + /** + * Obtains the external product series represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get brand(): string; + + /** + * Obtains the external product series represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get marketName(): string; + + /** + * Obtains the product series represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get productSeries(): string; + + + /** + * Obtains the product model represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @atomicservice + * @since 20 + */ + static get productModel(): string; + + /** + * Obtains the product model alias represented by a string. + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @atomicservice + * @since 20 + */ + static get productModelAlias(): string; + + /** + * Obtains the software model represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get softwareModel(): string; + + /** + * Obtains the hardware model represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get hardwareModel(): string; + + /** + * Obtains the hardware model represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get hardwareProfile(): string; + + /** + * Obtains the device serial number represented by a string. + * + * @permission ohos.permission.sec.ACCESS_UDID + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get serial(): string; + + /** + * Obtains the bootloader version number represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get bootloaderVersion(): string; + + /** + * Obtains the application binary interface (Abi) list represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get abiList(): string; + + /** + * Obtains the security patch level represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get securityPatchTag(): string; + + /** + * Obtains the product version represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get displayVersion(): string; + + /** + * Obtains the incremental version represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get incrementalVersion(): string; + + /** + * Obtains the OS release type represented by a string. + *

The OS release category can be {@code Release}, {@code Beta}, or {@code Canary}. + * The specific release type may be {@code Release}, {@code Beta1}, or others alike. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get osReleaseType(): string; + + + /** + * Obtains the OS version represented by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @atomicservice + * @since 20 + */ + static get osFullName(): string; + + /** + * Obtains the major (M) version number, which increases with any updates to the overall architecture. + *

The M version number monotonically increases from 1 to 99. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get majorVersion(): int; + + /** + * Obtains the senior (S) version number, which increases with any updates to the partial + * architecture or major features. + *

The S version number monotonically increases from 0 to 99. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get seniorVersion(): int; + + /** + * Obtains the feature (F) version number, which increases with any planned new features. + *

The F version number monotonically increases from 0 or 1 to 99. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get featureVersion(): int; + + /** + * Obtains the build (B) version number, which increases with each new development build. + *

The B version number monotonically increases from 0 or 1 to 999. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get buildVersion(): int; + + + /** + * Obtains the SDK API version number. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @atomicservice + * @since 20 + */ + static get sdkApiVersion(): int; + + /** + * Obtains the first API version number. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get firstApiVersion(): int; + + /** + * Obtains the version ID by a string. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get versionId(): string; + + /** + * Obtains the build types of the same baseline code. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get buildType(): string; + + /** + * Obtains the different build user of the same baseline code. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get buildUser(): string; + + /** + * Obtains the different build host of the same baseline code. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get buildHost(): string; + + /** + * Obtains the build time. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get buildTime(): string; + + /** + * Obtains the version hash. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @crossplatform + * @since 20 + */ + static get buildRootHash(): string; + + /** + * Obtains the device udid. + * + * @permission ohos.permission.sec.ACCESS_UDID + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get udid(): string; + + /** + * Obtains the Distribution OS name. + *

Independent Software Vendor (ISV) may distribute OHOS with their own OS name. + * distributionOsName will return the ISV OS name + * If ISV not specified, it will return an empty string + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get distributionOSName(): string; + + /** + * Obtains the Distribution OS version. + *

Independent Software Vendor (ISV) may distribute OHOS with their own OS version. + * distributionOSVersion will return the ISV OS version + * If ISV not specified, it will return the same value as osFullName + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get distributionOSVersion(): string; + + /** + * Obtains the Distribution OS version. + *

Independent Software Vendor (ISV) may distribute OHOS with their own OS api version. + * distributionOSVersion will return the ISV OS api version + * If ISV not specified, it will return the same value as sdkApiVersion + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get distributionOSApiVersion(): int; + + /** + * Obtains the Distribution OS api name. + *

Independent Software Vendor (ISV) may distribute OHOS with their own OS api name. + * distributionOSApiName will return the ISV OS api name + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get distributionOSApiName(): string; + + /** + * Obtains the Distribution OS release type. + *

Independent Software Vendor (ISV) may distribute OHOS with their own OS release type. + * distributionOSVersion will return the ISV OS release type + * If ISV not specified, it will return the same value as osReleaseType + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get distributionOSReleaseType(): string; + + /** + * Open Device Identifier (ODID): a developer-level non-permanent device identifier. + * A developer can be an enterprise or individual developer. + * Example: dff3cdfd-7beb-1e7d-fdf7-1dbfddd7d30c + * + * An ODID will be regenerate in the following scenarios: + * Restore a phone to its factory settings. + * Uninstall and reinstall all apps of one developer on one device. + * + * An ODID is generated based on the following rules: + * For apps from the same developer, which are running on the same device, they have the same ODID. + * For apps from different developers, which are running on the same device, each of them has its own ODID. + * For apps from the same developer, which are running on different devices, each of them has its own ODID. + * For apps from different developers, which are running on different devices, each of them has its own ODID. + * + * + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get ODID(): string; + + /** + * Obtaining the hard drive serial number. + * + * @permission ohos.permission.ACCESS_DISK_PHY_INFO + * @syscap SystemCapability.Startup.SystemInfo + * @since 20 + */ + static get diskSN(): string; +} +export default deviceInfo; diff --git a/api/@ohos.deviceStatus.dragInteraction.d.ts b/api/@ohos.deviceStatus.dragInteraction.d.ts index 7beaaf44f0ea0d66c347473c13de9aa1e4d2d5ca..c9a2540e6ba79f3189cb2924b4bf33a3672253cb 100644 --- a/api/@ohos.deviceStatus.dragInteraction.d.ts +++ b/api/@ohos.deviceStatus.dragInteraction.d.ts @@ -26,7 +26,8 @@ import { Callback } from './@ohos.base'; * @namespace dragInteraction * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace dragInteraction { /** @@ -35,7 +36,8 @@ declare namespace dragInteraction { * @enum { number } * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum DragState { /** @@ -43,7 +45,8 @@ declare namespace dragInteraction { * * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ MSG_DRAG_STATE_START = 1, @@ -52,7 +55,8 @@ declare namespace dragInteraction { * * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ MSG_DRAG_STATE_STOP = 2, @@ -61,7 +65,8 @@ declare namespace dragInteraction { * * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ MSG_DRAG_STATE_CANCEL = 3, } @@ -72,7 +77,8 @@ declare namespace dragInteraction { * @interface Summary * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Summary { /** @@ -81,19 +87,21 @@ declare namespace dragInteraction { * @type { string } * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ dataType: string; /** * Data length of the dragged object. * - * @type { number } + * @type { int } * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - dataSize: number; + dataSize: int; } /** @@ -117,7 +125,8 @@ declare namespace dragInteraction { *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'drag', callback: Callback): void; @@ -144,7 +153,8 @@ declare namespace dragInteraction { *
2.Incorrect parameter types.3.Parameter verification failed. * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'drag', callback?: Callback): void; @@ -155,7 +165,8 @@ declare namespace dragInteraction { * @throws {BusinessError} 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Msdp.DeviceStatus.Drag * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDataSummary(): Array

; diff --git a/api/@ohos.display.d.ts b/api/@ohos.display.d.ts index 801e4467bae5d7479fe9a9bd6fad3af17ce005fa..c218c6badda0a013d1de72454f19b2b1ca11a5ab 100644 --- a/api/@ohos.display.d.ts +++ b/api/@ohos.display.d.ts @@ -44,7 +44,8 @@ import type hdrCapability from './@ohos.graphics.hdrCapability'; * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace display { /** @@ -94,9 +95,10 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getDefaultDisplaySync(): Display; + export function getDefaultDisplaySync(): Display; /** * Obtain the primary display. @@ -121,9 +123,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getDisplayByIdSync(displayId: number): Display; + export function getDisplayByIdSync(displayId: number): Display; /** * Obtain all displays. @@ -134,7 +137,7 @@ declare namespace display { * @deprecated since 9 * @useinstead ohos.display#getAllDisplays */ - function getAllDisplay(callback: AsyncCallback>): void; + export function getAllDisplay(callback: AsyncCallback>): void; /** * Obtain all displays. @@ -162,9 +165,10 @@ declare namespace display { * @throws { BusinessError } 1400001 - Invalid display or screen. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getAllDisplays(callback: AsyncCallback>): void; + export function getAllDisplays(callback: AsyncCallback>): void; /** * Obtain all displays. @@ -192,9 +196,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getAllDisplayPhysicalResolution(): Promise>; + export function getAllDisplayPhysicalResolution(): Promise>; /** * Check whether there is a privacy window on the current display. @@ -207,9 +212,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - function hasPrivateWindow(displayId: number): boolean; + export function hasPrivateWindow(displayId: number): boolean; /** * Register the callback for display changes. @@ -230,9 +236,10 @@ declare namespace display { *
2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'add' | 'remove' | 'change', callback: Callback): void; + export function on(type: 'add' | 'remove' | 'change', callback: Callback): void; /** * Unregister the callback for display changes. @@ -253,9 +260,10 @@ declare namespace display { *
2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'add' | 'remove' | 'change', callback?: Callback): void; + export function off(type: 'add' | 'remove' | 'change', callback?: Callback): void; /** * Register the callback for private mode changes. @@ -267,9 +275,10 @@ declare namespace display { *
2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'privateModeChange', callback: Callback): void; + export function on(type: 'privateModeChange', callback: Callback): void; /** * Unregister the callback for private mode changes. @@ -281,9 +290,10 @@ declare namespace display { *
2. Incorrect parameter types. * @syscap SystemCapability.WindowManager.WindowManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'privateModeChange', callback?: Callback): void; + export function off(type: 'privateModeChange', callback?: Callback): void; /** * Check whether the device is foldable. @@ -300,9 +310,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function isFoldable(): boolean; + export function isFoldable(): boolean; /** * Get the current fold status of the foldable device. @@ -319,9 +330,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getFoldStatus(): FoldStatus; + export function getFoldStatus(): FoldStatus; /** * Register the callback for fold status changes. @@ -344,9 +356,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'foldStatusChange', callback: Callback): void; + export function on(type: 'foldStatusChange', callback: Callback): void; /** * Unregister the callback for fold status changes. @@ -369,9 +382,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'foldStatusChange', callback?: Callback): void; + export function off(type: 'foldStatusChange', callback?: Callback): void; /** * Register the callback for fold angle changes. @@ -383,9 +397,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'foldAngleChange', callback: Callback>): void; + export function on(type: 'foldAngleChange', callback: Callback>): void; /** * Unregister the callback for fold angle changes. @@ -397,9 +412,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'foldAngleChange', callback?: Callback>): void; + export function off(type: 'foldAngleChange', callback?: Callback>): void; /** * Register the callback for device capture status changes. @@ -411,9 +427,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'captureStatusChange', callback: Callback): void; + export function on(type: 'captureStatusChange', callback: Callback): void; /** * Unregister the callback for device capture status changes. @@ -425,9 +442,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'captureStatusChange', callback?: Callback): void; + export function off(type: 'captureStatusChange', callback?: Callback): void; /** @@ -437,9 +455,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function isCaptured(): boolean; + export function isCaptured(): boolean; /** * Get the display mode of the foldable device. @@ -456,9 +475,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getFoldDisplayMode(): FoldDisplayMode; + export function getFoldDisplayMode(): FoldDisplayMode; /** * Change the display mode of the foldable device. @@ -470,9 +490,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setFoldDisplayMode(mode: FoldDisplayMode): void; + export function setFoldDisplayMode(mode: FoldDisplayMode): void; /** * Change the display mode of the foldable device. @@ -485,9 +506,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setFoldDisplayMode(mode: FoldDisplayMode, reason: string): void; + export function setFoldDisplayMode(mode: FoldDisplayMode, reason: string): void; /** * Register the callback for fold display mode changes. @@ -510,9 +532,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'foldDisplayModeChange', callback: Callback): void; + export function on(type: 'foldDisplayModeChange', callback: Callback): void; /** * Unregister the callback for fold display mode changes. @@ -535,9 +558,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'foldDisplayModeChange', callback?: Callback): void; + export function off(type: 'foldDisplayModeChange', callback?: Callback): void; /** * Get the fold crease region in the current display mode. @@ -554,9 +578,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getCurrentFoldCreaseRegion(): FoldCreaseRegion; + export function getCurrentFoldCreaseRegion(): FoldCreaseRegion; /** * set fold status locked or not. @@ -568,9 +593,10 @@ declare namespace display { * @throws { BusinessError } 1400003 - This display manager service works abnormally. * @syscap SystemCapability.Window.SessionManager * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setFoldStatusLocked(locked: boolean): void; + export function setFoldStatusLocked(locked: boolean): void; /** * Create virtual screen. @@ -662,7 +688,8 @@ declare namespace display { * * @type { number } * @syscap SystemCapability.Window.SessionManager - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -671,7 +698,8 @@ declare namespace display { * * @type { number } * @syscap SystemCapability.Window.SessionManager - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -707,9 +735,10 @@ declare namespace display { * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - enum FoldStatus { + export enum FoldStatus { /** * Fold Status Unknown. * @@ -721,7 +750,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_UNKNOWN = 0, /** @@ -735,9 +765,10 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - FOLD_STATUS_EXPANDED, + FOLD_STATUS_EXPANDED = 1, /** * Fold Status Folded. * @@ -749,9 +780,10 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - FOLD_STATUS_FOLDED, + FOLD_STATUS_FOLDED = 2, /** * Fold Status Half Folded. * @@ -763,15 +795,17 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - FOLD_STATUS_HALF_FOLDED, + FOLD_STATUS_HALF_FOLDED = 3, /** * Fold Status Expanded With Second Expanded. * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_EXPANDED_WITH_SECOND_EXPANDED = 11, /** @@ -779,7 +813,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_EXPANDED_WITH_SECOND_HALF_FOLDED = 21, /** @@ -787,7 +822,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_FOLDED_WITH_SECOND_EXPANDED = 12, /** @@ -795,7 +831,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_FOLDED_WITH_SECOND_HALF_FOLDED = 22, /** @@ -803,7 +840,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_HALF_FOLDED_WITH_SECOND_EXPANDED = 13, /** @@ -811,7 +849,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_STATUS_HALF_FOLDED_WITH_SECOND_HALF_FOLDED = 23 } @@ -829,9 +868,10 @@ declare namespace display { * @enum { number } * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - enum FoldDisplayMode { + export enum FoldDisplayMode { /** * Unknown Display. * @@ -843,7 +883,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_DISPLAY_MODE_UNKNOWN = 0, /** @@ -857,9 +898,10 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - FOLD_DISPLAY_MODE_FULL, + FOLD_DISPLAY_MODE_FULL = 1, /** * Main Display. * @@ -871,9 +913,10 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - FOLD_DISPLAY_MODE_MAIN, + FOLD_DISPLAY_MODE_MAIN = 2, /** * Sub Display. * @@ -885,9 +928,10 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - FOLD_DISPLAY_MODE_SUB, + FOLD_DISPLAY_MODE_SUB = 3, /** * Coordination Display. * @@ -899,7 +943,8 @@ declare namespace display { * * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ FOLD_DISPLAY_MODE_COORDINATION } @@ -917,9 +962,10 @@ declare namespace display { * @enum { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - enum DisplayState { + export enum DisplayState { /** * Unknown. * @@ -931,7 +977,8 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ STATE_UNKNOWN = 0, /** @@ -945,9 +992,10 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - STATE_OFF, + STATE_OFF = 1, /** * Screen on. * @@ -959,9 +1007,10 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - STATE_ON, + STATE_ON = 2, /** * Doze, but it will update for some important system messages. * @@ -973,9 +1022,10 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - STATE_DOZE, + STATE_DOZE = 3, /** * Doze and not update. * @@ -987,9 +1037,10 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - STATE_DOZE_SUSPEND, + STATE_DOZE_SUSPEND = 4, /** * VR node. * @@ -1001,9 +1052,10 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - STATE_VR, + STATE_VR = 5, /** * Screen on and not update. * @@ -1015,9 +1067,10 @@ declare namespace display { * * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - STATE_ON_SUSPEND + STATE_ON_SUSPEND = 6 } /** @@ -1035,9 +1088,10 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - enum Orientation { + export enum Orientation { /** * Indicate that the display content is in portrait mode. * @@ -1051,7 +1105,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PORTRAIT = 0, @@ -1068,7 +1123,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LANDSCAPE = 1, @@ -1085,7 +1141,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PORTRAIT_INVERTED = 2, @@ -1102,7 +1159,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LANDSCAPE_INVERTED = 3 } @@ -1202,9 +1260,10 @@ declare namespace display { * @interface FoldCreaseRegion * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface FoldCreaseRegion { + export interface FoldCreaseRegion { /** * The display ID is used to identify the screen where the crease is located. * @@ -1220,7 +1279,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly displayId: number; @@ -1239,7 +1299,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.Window.SessionManager * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly creaseRects: Array; } @@ -1257,7 +1318,8 @@ declare namespace display { * @interface Rect * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Rect { /** @@ -1273,7 +1335,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ left: number; @@ -1290,7 +1353,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ top: number; @@ -1307,7 +1371,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -1324,7 +1389,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -1342,9 +1408,10 @@ declare namespace display { * @interface WaterfallDisplayAreaRects * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface WaterfallDisplayAreaRects { + export interface WaterfallDisplayAreaRects { /** * Indicates the size of left side curved area of the waterfall screen. * @@ -1360,7 +1427,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly left: Rect; @@ -1379,7 +1447,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly right: Rect; @@ -1398,7 +1467,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly top: Rect; @@ -1417,7 +1487,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly bottom: Rect; } @@ -1435,9 +1506,10 @@ declare namespace display { * @interface CutoutInfo * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface CutoutInfo { + export interface CutoutInfo { /** * Bounding rectangles of the cutout areas of the display. * @@ -1453,7 +1525,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly boundingRects: Array; @@ -1472,7 +1545,8 @@ declare namespace display { * @readonly * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly waterfallDisplayAreaRects: WaterfallDisplayAreaRects; } @@ -1484,16 +1558,18 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface DisplayPhysicalResolution { + export interface DisplayPhysicalResolution { /** * fold display mode. * * @type { FoldDisplayMode } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ foldDisplayMode: FoldDisplayMode; @@ -1504,7 +1580,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ physicalWidth: number; @@ -1515,7 +1592,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ physicalHeight: number; } @@ -1542,9 +1620,10 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - interface Display { + export interface Display { /** * Display ID. * @@ -1567,7 +1646,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -1584,7 +1664,8 @@ declare namespace display { * @type { string } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -1601,7 +1682,8 @@ declare namespace display { * @type { boolean } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ alive: boolean; @@ -1618,7 +1700,8 @@ declare namespace display { * @type { DisplayState } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ state: DisplayState; @@ -1635,7 +1718,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ refreshRate: number; @@ -1656,7 +1740,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ rotation: number; @@ -1682,7 +1767,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -1708,7 +1794,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -1719,7 +1806,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ availableWidth: number; @@ -1730,7 +1818,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ availableHeight: number; @@ -1756,7 +1845,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ densityDPI: number; @@ -1775,7 +1865,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ orientation: Orientation; @@ -1793,7 +1884,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ densityPixels: number; @@ -1819,7 +1911,8 @@ declare namespace display { * @syscap SystemCapability.WindowManager.WindowManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scaledDensity: number; @@ -1836,7 +1929,8 @@ declare namespace display { * @type { number } * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ xDPI: number; @@ -1946,7 +2040,8 @@ declare namespace display { * @throws { BusinessError } 1400001 - Invalid display or screen. * @syscap SystemCapability.WindowManager.WindowManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getCutoutInfo(callback: AsyncCallback): void; diff --git a/api/@ohos.distributedDeviceManager.d.ets b/api/@ohos.distributedDeviceManager.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..1912263af9d365e9d37d927a9106d27bd160fe34 --- /dev/null +++ b/api/@ohos.distributedDeviceManager.d.ets @@ -0,0 +1,646 @@ +/* + * Copyright (c) 2023-2024 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 DistributedServiceKit + */ + +import type { AsyncCallback, Callback } from './@ohos.base'; + +/** + * Providers interfaces to create a {@link deviceManager} instances. + * + * @namespace distributedDeviceManager + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + +declare namespace distributedDeviceManager { + + /** + * Basic description information of a distributed device. + * @interface DeviceBasicInfo + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + export interface DeviceBasicInfo { + /** + * Device identifier. The actual value is udid-hash confused with appid and salt value based on sha256. + * This id remains unchanged after application installation. If the application is uninstalled and reinstalled, + * the obtained ID will change. + * @type { string } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + deviceId: string; + + /** + * Device name. + * @type { string } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + deviceName: string; + + /** + * Obtains the device type represented by a string, + * which can be {@code phone}, {@code tablet}, {@code tv}, {@code smartVision}, {@code car}. + * @type { string } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + deviceType: string; + + /** + * Device network id. + * @type { ?string } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + networkId?: string; + } + + /** + * The state of the nearby devices. + * @enum { number } + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + export enum DeviceStateChange { + /** + * This state indicates the device is online but the state is unknown,The distributed function cannot used until + * state changes to AVAILABLE. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + UNKNOWN = 0, + + /** + * This state indicates the device has been synchronized to the database, Now the distributed function can be used. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + AVAILABLE = 1, + + /** + * This state indicates the device is offline. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + UNAVAILABLE = 2, + } + + /** + * Creates an {@code DeviceManager} instance. + * + * To manage devices, you must first call this method to obtain a {@code DeviceManager} instance and then + * use this instance to call other device management methods. + * + * @param { string } bundleName - Indicates the bundle name of the application. + * @returns { DeviceManager } - Return the DeviceManager object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + export function createDeviceManager(bundleName: string): DeviceManager; + + /** + * Releases the {@code DeviceManager} instance that is no longer used. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { DeviceManager } deviceManager - Indicates the {@code DeviceManager} instance. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + export function releaseDeviceManager(deviceManager: DeviceManager): void; + + interface DeviceResult { + deviceId: string; + } + + interface DeviceResultNumber { + reason: number; + } + + type DeviceResultCallback = AsyncCallback; + +// 定义接口 +interface DeviceStateChangeData { + action: DeviceStateChange; + device: DeviceBasicInfo; +} + +interface DeviceStateChangeAction { + device: DeviceBasicInfo; +} + +// 提取类型 +type DeviceStateChangeCallback = Callback; + +type DeviceStateChangeCallbackAction = Callback; + +type DeviceStateString = Callback; +type DeviceStateNumber = Callback; + +interface ServiceDieData {} +type ServiceDieCallback = Callback; + /** + * Provides methods for managing devices. + * + * @interface DeviceManager + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + export interface DeviceManager { + + /** + * Get a list of available devices. This interface query all authorized and connectable devices. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @returns { Array } - Returns a list of available devices. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter types; + * 3. Parameter verification failed. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getAvailableDeviceListSync(): Array; + + /** + * Get a list of available devices. This interface query all authorized and connectable devices. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { AsyncCallback> } callback - Indicates the callback to be + * invoked upon getAvailableDeviceList. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getAvailableDeviceList(callback: AsyncCallback>): void; + + /** + * Get a list of available devices. This interface query all authorized and connectable devices. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @returns { Promise> } - Returns a list of available devices. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getAvailableDeviceList(): Promise>; + + /** + * Get the network id of the local device. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @returns { string } - Returns local device network id. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getLocalDeviceNetworkId(): string; + + /** + * Get the device name of the local device. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @returns { string } - Returns local device name. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getLocalDeviceName(): string; + + /** + * Get the device type of the local device. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @returns { number } - Returns local device type. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getLocalDeviceType(): number; + + /** + * Get the device id of the local device. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @returns { string } - Device identifier. The actual value is udid-hash confused with appid and salt value based on sha256. + * This id remains unchanged after application installation. If the application is uninstalled and reinstalled, + * the obtained ID will change. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getLocalDeviceId(): string; + + /** + * Get the device name by network id. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string } networkId - Device network id. + * @returns { string } - Returns device name. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified networkId is greater than 255. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getDeviceName(networkId: string): string; + + /** + * Get the device type by network id. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string } networkId - Device network id. + * @returns { double } - Returns device type. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified networkId is greater than 255. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + getDeviceType(networkId: string): double; + + /** + * Start to discover nearby devices. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { object } discoverParam - Identifies the type of target discovered: + * discoverTargetType : 1 - Discovery target as a device by default, the value is 1. + * @param { object } filterOptions - FilterOptions to filter discovery device. + * The type of filterOptions is map. The map are as follows: + * availableStatus: 0-1 - Discover devices only are credible, The value is 0 indicates device isn't credible; + * 0: Devices are offline, client need to bind the device by calling bindTarget() and then connect to it. + * 1: Devices already online, client can make connection. + * discoverDistance: 0-100 - Discover devices within a certain distance from the local, the unit is cm. + * authenticationStatus: 0-1 - Discover devices based on different authentication status: + * 0: Devices not authenticated. + 1: Devices already authenticated. + * The value is 1 indicates device is trust. + * authorizationType: 0-2 - Discover devices based on different authorization type: + * 0: Devices authenticated based on temporary negotiated session key. + * 1: Devices authenticated based on the same account credential key. + * 2: Devices authenticated based on different account credential keys. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 11600104 - Discovery unavailable. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + startDiscovering(discoverParam: Record, filterOptions?: Record): void; + + /** + * Stop discovering nearby devices. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 11600104 - Discovery unavailable. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + stopDiscovering(): void; + + /** + * Bind the specified target. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string } deviceId - id of device to bind. + * @param { object } bindParam - parameters of device to bind, The parameter type is map,such as: + * "bindType" : 1, - This value is type of bind, the values are as follows: + * 1 - The bind type is pin code . + + * "targetPkgName" : "xxxx", - The package name of binding target. + * "appName" : "xxxx", - The app name that try to bind the target. + * "appOperation" : "xxxx" - The reason why the app want to bind the target package. + * "customDescription" : "xxxx" - The detail description of the operation. + * @param { AsyncCallback<{deviceId: string;}> } callback - indicates the callback to be invoked upon bindDevice. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified deviceId is greater than 255. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @throws { BusinessError } 11600103 - Authentication unavailable. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + bindTarget(deviceId: string, bindParam: Record, callback: DeviceResultCallback): void; + + /** + * Unbind the specified target. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string } deviceId - id of device to unbind + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified deviceId is greater than 255. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 11600101 - Failed to execute the function. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + unbindTarget(deviceId: string): void; + + /** + * The reply of ui operation from pin-code window, this interface can only be used by pin-code-hap of devicemanager. + * + * @permission ohos.permission.ACCESS_SERVICE_DM + * @param { number } action - The reply action of user operation. + * @param { string } actionResult - Indicates the user operation result. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified actionResult is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi this method can be used only by system applications. + * @since 10 + */ + replyUiAction(action: number, actionResult: string): void; + + /** + * Register a device state callback so that the application can be notified upon device state changes based on + * the application bundle name. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'deviceStateChange' } type - Device state change. + * @param { Callback<{ action: DeviceStateChange; device: DeviceBasicInfo; }> } callback + * Indicates the device state callback to register. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + on(type: 'deviceStateChange', callback: DeviceStateChangeCallback): void; + + /** + * UnRegister device state callback based on the application bundle name. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'deviceStateChange' } type - Device state change. + * @param { Callback<{ action: DeviceStateChange; device: DeviceBasicInfo; }> } callback + * Indicates the device state callback to unregister. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + off(type: 'deviceStateChange', callback?: DeviceStateChangeCallback): void; + + /** + * Register a device discovery result callback so that the application can be notified when discovery success. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'discoverSuccess' } type - Successfully discovered device. + * @param { Callback<{ device: DeviceBasicInfo; }> } callback - Indicates the device discovery callback to register. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + on(type: 'discoverSuccess', callback: DeviceStateChangeCallbackAction): void; + + /** + * UnRegister the device discovery result callback. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'discoverSuccess' } type - Successfully discovered device. + * @param { Callback<{ device: DeviceBasicInfo; }> } callback - Indicates the device discovery callback to unregister. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + off(type: 'discoverSuccess', callback?: DeviceStateChangeCallbackAction): void; + + /** + * Register a device name change callback so that the application can be notified when discovery success. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'deviceNameChange' } type - Changed device name. + * @param { Callback<{ deviceName: string; }> } callback - Indicates the device name change callback to register. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + on(type: 'deviceNameChange', callback: DeviceStateString): void; + + /** + * UnRegister the device name change result callback. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'deviceNameChange' } type - Changed device name. + * @param { Callback<{ deviceName: string; }> } callback - Indicates the device name change callback to unregister. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + off(type: 'deviceNameChange', callback?: DeviceStateString): void; + + /** + * Register a device discovery result callback so that the application can be notified when discover failed. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'discoverFailure' } type - Discovery Device Failure. + * @param { Callback<{ reason: number; }> } callback + * Indicates the device found result callback to register. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + on(type: 'discoverFailure', callback: DeviceStateNumber): void; + + /** + * UnRegister the device discovery result callback. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'discoverFailure' } type - Discovery Device Failure. + * @param { Callback<{ reason: number; }> } callback + * Indicates the device found result callback to unregister. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + off(type: 'discoverFailure', callback?: DeviceStateNumber): void; + + /** + * Register a serviceError callback so that the application can be notified when devicemanager service died + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'serviceDie' } type - Service death. + * @param { Callback<{}> } callback - Indicates the service error callback to register. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + on(type: 'serviceDie', callback?: ServiceDieCallback): void; + + /** + * UnRegister the service error callback. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { 'serviceDie' } type - Service death. + * @param { Callback<{}> } callback - Indicates the service error callback to unregister. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission + * required to call the API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @since 10 + */ + off(type: 'serviceDie', callback?: ServiceDieCallback): void; + + /** + * Register a callback from deviceManager service so that the devicemanager ui can be notified when uiStateChanges. + * + * @permission ohos.permission.ACCESS_SERVICE_DM + * @param { 'replyResult' } type - Ui reply result to register. + * @param { Callback<{ param: string; }> } callback - Indicates the devicemanager ui state to register. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi this method can be used only by system applications. + * @since 10 + */ + on(type: 'replyResult', callback: DeviceStateString): void; + + /** + * Unregister uiStateChange, this interface can only be used by devicemanager ui. + * + * @permission ohos.permission.ACCESS_SERVICE_DM + * @param { 'replyResult' } type - Ui reply result to unregister. + * @param { Callback<{ param: string; }> } callback - Indicates the devicemanager ui state to unregister. + * @throws { BusinessError } 401 - Parameter error. Possible causes: + * 1. Mandatory parameters are left unspecified; + * 2. Incorrect parameter type; + * 3. Parameter verification failed; + * 4. The size of specified type is greater than 255. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @syscap SystemCapability.DistributedHardware.DeviceManager + * @systemapi this method can be used only by system applications. + * @since 10 + */ + off(type: 'replyResult', callback?: DeviceStateString): void; + } +} + +export default distributedDeviceManager; \ No newline at end of file diff --git a/api/@ohos.driver.deviceManager.d.ts b/api/@ohos.driver.deviceManager.d.ts index a112554dff370c7615c25584ce490667de8dd2ec..d2f07bd2e7b01108cd1bf850b12d26a2da4d7268 100644 --- a/api/@ohos.driver.deviceManager.d.ts +++ b/api/@ohos.driver.deviceManager.d.ts @@ -198,8 +198,6 @@ declare namespace deviceManager { * success. * @returns { Promise } Indicates the bind result including device ID and remote object. * @throws { BusinessError } 201 - The permission check failed. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. - * 3.Parameter verification failed. * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. * @throws { BusinessError } 26300002 - Service not allowed. * @syscap SystemCapability.Driver.ExternalDevice @@ -214,8 +212,6 @@ declare namespace deviceManager { * @param { number } deviceId - Device id on the device list returned by queryDevices(). * @returns { Promise } - Indicates the unbind result invoked when unbind is finished. * @throws { BusinessError } 201 - The permission check failed. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types. - * 3.Parameter verification failed. * @throws { BusinessError } 26300001 - ExternalDeviceManager service exception. * @throws { BusinessError } 26300003 - There is no binding relationship. * @syscap SystemCapability.Driver.ExternalDevice diff --git a/api/@ohos.effectKit.d.ts b/api/@ohos.effectKit.d.ts index d69fb32a1c7adbb54b2a801069e4ba601468afec..301e96c287c6448ec67e6597b3b997252228e20d 100644 --- a/api/@ohos.effectKit.d.ts +++ b/api/@ohos.effectKit.d.ts @@ -18,8 +18,13 @@ * @kit ArkGraphics2D */ +/*** if arkts 1.1 */ import { AsyncCallback } from './@ohos.base'; import image from './@ohos.multimedia.image'; +/*** endif */ +/*** if arkts 1.2 */ +import image from './@ohos.multimedia.image'; +/*** endif */ /** * @namespace effectKit @@ -36,7 +41,8 @@ import image from './@ohos.multimedia.image'; * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace effectKit { @@ -62,7 +68,8 @@ declare namespace effectKit { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Filter { @@ -90,7 +97,8 @@ declare namespace effectKit { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ blur(radius: number): Filter; @@ -224,7 +232,8 @@ declare namespace effectKit { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ getEffectPixelMap(): Promise; } @@ -581,7 +590,8 @@ declare namespace effectKit { * @crossplatform * @form * @atomicservice - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ function createEffect(source: image.PixelMap): Filter; diff --git a/api/@ohos.events.emitter.d.ts b/api/@ohos.events.emitter.d.ts index 659557d41bab4019cfb641bebc82aa35764add47..a36debc3175ef4498d82f9e6321a19c8df70a066 100644 --- a/api/@ohos.events.emitter.d.ts +++ b/api/@ohos.events.emitter.d.ts @@ -42,7 +42,8 @@ import { Callback } from './@ohos.base'; * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace emitter { /** @@ -70,9 +71,10 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(event: InnerEvent, callback: Callback): void; + export function on(event: InnerEvent, callback: Callback): void; /** * Subscribe to a event by specific id in persistent manner and receives the event callback. @@ -91,7 +93,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(eventId: string, callback: Callback): void; @@ -103,10 +106,24 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(eventId: string, callback: Callback>): void; + /** + * Subscribe to a event by specific id in persistent manner and receives the event callback. + * + * @param { string } eventId - indicate ID of the event to subscribe to. + * @param { Callback | Callback> } callback - indicate callback used to receive the event. + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function on(eventId: string, callback: Callback | Callback>): void; + /** * Subscribe to a certain event in one-shot manner and unsubscribe from it * after the event callback is received. @@ -135,7 +152,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function once(event: InnerEvent, callback: Callback): void; @@ -158,7 +176,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function once(eventId: string, callback: Callback): void; @@ -171,7 +190,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function once(eventId: string, callback: Callback>): void; @@ -197,9 +217,10 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(eventId: number): void; + export function off(eventId: number): void; /** * Unsubscribe from an event. @@ -218,7 +239,17 @@ declare namespace emitter { * @atomicservice * @since 12 */ - function off(eventId: string): void; + /** + * Unsubscribe from an event. + * + * @param { string } eventId - indicate ID of the event to unsubscribe from. + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 + */ + export function off(eventId: string): void; /** * Unsubscribe from an event. @@ -245,9 +276,10 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(eventId: number, callback: Callback): void; + export function off(eventId: number, callback: Callback): void; /** * Unsubscribe from an event. @@ -266,7 +298,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(eventId: string, callback: Callback): void; @@ -278,10 +311,24 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(eventId: string, callback: Callback>): void; + /** + * Unsubscribe specified callback function from an event. + * + * @param { string } eventId - indicates ID of the event to unsubscribe from. + * @param { Callback | Callback> } callback - indicates callback used to receive the event. + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function off(eventId: string, callback: Callback | Callback>): void; + /** * Emits an event to the event queue. * @@ -307,9 +354,10 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function emit(event: InnerEvent, data?: EventData): void; + export function emit(event: InnerEvent, data?: EventData): void; /** * Emits an event by specific id to the event queue. @@ -328,7 +376,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function emit(eventId: string, data?: EventData): void; @@ -340,10 +389,24 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function emit(eventId: string, data?: GenericEventData): void; + /** + * Emits an event by specific id to the event queue. + * + * @param { string } eventId - indicate ID of the event to emit. + * @param { EventData | GenericEventData } [data] - indicate data carried by the event. + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export function emit(eventId: string, data?: EventData | GenericEventData): void; + /** * Emits an event by specific id to the event queue. * @@ -365,7 +428,19 @@ declare namespace emitter { * @atomicservice * @since 12 */ - function emit(eventId: string, options: Options, data?: EventData): void; + /** + * Emits an event by specific id to the event queue. + * + * @param { string } eventId - indicate ID of the event to emit. + * @param { Options } options - Indicates the {@link Options} option of the emit priority of the event. + * @param { EventData } [data] - indicate data carried by the event. + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 + */ + export function emit(eventId: string, options: Options, data?: EventData): void; /** * Emits an event by specific id to the event queue. @@ -378,7 +453,19 @@ declare namespace emitter { * @atomicservice * @since 12 */ - function emit(eventId: string, options: Options, data?: GenericEventData): void; + /** + * Emits an event by specific id to the event queue. + * + * @param { string } eventId - indicate ID of the event to emit. + * @param { Options } options - Indicates the {@link Options} option of the emit priority of the event. + * @param { GenericEventData } [data] - indicate data carried by the event. + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 + */ + export function emit(eventId: string, options: Options, data?: GenericEventData): void; /** * Obtains the number of subscribe listener count. @@ -397,9 +484,10 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getListenerCount(eventId: number | string): number; + export function getListenerCount(eventId: number | string): number; /** * Describes data passed in the event. @@ -423,7 +511,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface EventData { /** @@ -451,6 +540,18 @@ declare namespace emitter { * @since 12 */ data?: { [key: string]: any }; + + /** + * Data carried by the event. + * + * @type { ?object } + * @syscap SystemCapability.Notification.Emitter + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + data?: Record; } /** @@ -475,7 +576,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface InnerEvent { /** @@ -500,7 +602,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ eventId: number; @@ -526,7 +629,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ priority?: EventPriority; } @@ -553,7 +657,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum EventPriority { /** @@ -575,7 +680,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ IMMEDIATE = 0, @@ -598,7 +704,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ HIGH, @@ -621,7 +728,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LOW, @@ -644,7 +752,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ IDLE, } @@ -663,7 +772,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Options { /** @@ -681,7 +791,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ priority?: EventPriority; } @@ -693,7 +804,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface GenericEventData { /** @@ -703,7 +815,8 @@ declare namespace emitter { * @syscap SystemCapability.Notification.Emitter * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ data?: T; } diff --git a/api/@ohos.file.backup.d.ets b/api/@ohos.file.backup.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..e84f3ce7f6eef1a53eea12a40da3a2c414c63424 --- /dev/null +++ b/api/@ohos.file.backup.d.ets @@ -0,0 +1,838 @@ +/* + * Copyright (c) 2023-2024 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 CoreFileKit + */ + +import type { AsyncCallback, Callback } from './@ohos.base'; + +/** + * Module providing backup and restore capabilities. + * + * @namespace backup + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ +declare namespace backup { + /** + * Corresponding to a file's metadata. FileMeta is useful when doing IPC with the backup service. + * + * @interface FileMeta + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + interface FileMeta { + /** + * Indicates the name of a bundle. + * + * @type { string } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + bundleName: string; + + /** + * Indicates a uri to a file. + * + * @type { string } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + uri: string; + } + + /** + * Corresponding to a file's data. Filedata is useful when doing IPC with the backup service. + * + * @interface FileData + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + interface FileData { + /** + * Indicates a native file descriptor typically retrieved from the backup service to hold the file's content. + * + * @type { number } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + fd: number; + } + + /** + * Save the time information of the incremental backup. IncrementalBackupTime is useful when doing IPC with the backup service. + * + * @interface IncrementalBackupTime + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + interface IncrementalBackupTime { + /** + * Indicates the name of a bundle. + * + * @type { string } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + bundleName: string; + + /** + * Time of the last incremental backup + * + * @type { number } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + lastIncrementalTime: number; + } + + /** + * Manifest file information in incremental data. FileManifestData is useful when doing IPC with the backup service. + * + * @interface FileManifestData + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + interface FileManifestData { + /** + * A file descriptor for the manifest file that holds the data + * + * @type { number } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + manifestFd: number; + } + + /** + * Provides configuration parameters for backup and restore. + * + * @interface BackupParams + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + interface BackupParams { + /** + * The optional parameters a json strings in the form of key value in backup or restore. + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + parameters?: string; + } + + /** + * Control backup and restore priority sequence + * + * @interface BackupPriority + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + interface BackupPriority { + /** + * Indicates the priority of a bundle. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + priority?: number; + } + + /** + * Corresponds to an incremental application, including its last incremental time and incremental list. + * + * @interface IncrementalBackupData + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + interface IncrementalBackupData extends IncrementalBackupTime, FileManifestData, BackupParams, BackupPriority {} + + /** + * Corresponding to a file, including its metadata and data. + * File is useful when doing IPC with the backup service. + * + * @interface File + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + /** + * Corresponds to a file, including its metadata and data and the file's manifest data. + * Files are useful as IPC and backup services. + * + * @interface File + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + interface File extends FileMeta, FileData, FileManifestData {} + + /** + * Obtain a Json file that describes local capabilities. + * + * @permission ohos.permission.BACKUP + * @returns { Promise } A FileData holding all the local capabilities. The returned file is a temporal file that will be + * deleted automatically when closed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + function getLocalCapabilities(): Promise; + + /** + * Obtain a Json file that describes local capabilities. + * + * @permission ohos.permission.BACKUP + * @param { AsyncCallback } callback A callback method, the argument FileData will holding all the local capabilities. + * The returned file is a temporal file that will be deleted automatically when closed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + function getLocalCapabilities(callback: AsyncCallback): void; + + /** + * Obtain a json file that describes local capabilities. + * + * @permission ohos.permission.BACKUP + * @param { Array } dataList + * @returns { Promise } A FileData holding all the local capabilities. The returned file is a temporal file that will be + * deleted automatically when closed. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + function getLocalCapabilities(dataList: Array): Promise; + + /** + * Get Backup information from bundle. + * + * @permission ohos.permission.BACKUP + * @param { string } bundleToBackup Bundle to backup. + * @returns { string } Return the backup application's info. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + function getBackupInfo(bundleToBackup: string): string; + + /** + * Update backup or restore timeout. + * + * @permission ohos.permission.BACKUP + * @param { string } bundleName set update to bundleName app. + * @param { number } timeout Update backup or restore timeout(unit:ms). + * @returns { boolean } Return update result, true is success, false is fail. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + function updateTimer(bundleName: string, timeout: number): boolean; + + /** + * Update send file fd rate. + * + * @permission ohos.permission.BACKUP + * @param { string } bundleName set update to bundleName app. + * @param { number } sendRate set send file fd rate. + * @returns { boolean } Return update result, true is success, false is fail. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + function updateSendRate(bundleName: string, sendRate: number): boolean; + + /** + * General callbacks for both backup and restore procedure. + * The backup service will notify the client by these callbacks. + * + * @interface GeneralCallbacks + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + interface GeneralCallbacks { + /** + * Callback called when the backup service tries to send files to the client. + * The File argument indicates a file to send to the client. + * The returned file is owned by the backup service and will be cleaned by the service once the file is closed. + * + * @type { AsyncCallback } + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + onFileReady: AsyncCallback; + + /** + * Callback called when a backup/restore procedure for an bundle is started. + * The return string argument indicates the name of the bundle. + * + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + /** + * Callback called when a backup/restore procedure for an bundle is started. + * The first return string parameter indicates the name of the bundle. + * The second return string parameter indicates that when BusinessError errors occur, + * the callback data is the name of the bundle. + * + * @type { AsyncCallback } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13500001 - The application is not added to the backup or restore + * @throws { BusinessError } 13500002 - Failed to start application extension Procedure + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + onBundleBegin: AsyncCallback; + + /** + * Callback called when a backup/restore procedure for an bundle ends successfully or gets aborted unexpectedly. + * The return string argument indicates the name of the bundle. + * + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + /** + * Callback called when a backup/restore procedure for an bundle ends successfully or gets aborted unexpectedly. + * The first return string parameter indicates the name of the bundle. + * The second return string parameter indicates that when BusinessError errors occur, + * the callback data is the name of the bundle. + * + * @type { AsyncCallback } + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13500003 - Backup or restore timed out + * @throws { BusinessError } 13500004 - Application extension death + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + onBundleEnd: AsyncCallback; + + /** + * Callback called when the all the bundles to backup/restore are done or aborted unexpectedly. + * + * @type { AsyncCallback } + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + onAllBundlesEnd: AsyncCallback; + + /** + * Callback called when the backup service dies unexpectedly. + * + * @type { Callback } + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + onBackupServiceDied: Callback; + + /** + * Callback called when the backup service return result information. + * The first return string parameter indicates the bundleName that triggers the callback. + * The second return string parameter indicates the result of the bundle. + * + * @param { string } bundleName the bundleName that triggers the callback. + * @param { string } result the result of the bundle. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + onResultReport(bundleName: string, result: string):void; + + /** + * Callback called when the backup_sa service return result information. + * The first return string parameter indicates the result of the bundle. + * + * @param { string } bundleName the bundleName that triggers the callback. + * @param { string } process the process info of the bundle. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13500006 - Tar error + * @throws { BusinessError } 13500008 - Untar error + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + onProcess(bundleName: string, process: string):void; + } + + /** + * Control class for backup procedure. + * + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + class SessionBackup { + /** + * Constructor for obtaining the instance of the SessionBackup class. + * + * @permission ohos.permission.BACKUP + * @param { GeneralCallbacks } callbacks Callbacks to be registered for the backup. + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + constructor(callbacks: GeneralCallbacks); + + /** + * Append new bundles to backup. + * + * @permission ohos.permission.BACKUP + * @param { string[] } bundlesToBackup Bundles to backup. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + /** + * Append new bundles and backupInfos to backup. + * + * @permission ohos.permission.BACKUP + * @param { string[] } bundlesToBackup Bundles to backup. + * @param { string[] } infos Infos to backup. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + appendBundles(bundlesToBackup: string[], infos?: string[]): Promise; + + /** + * Append new bundles to backup. + * + * @permission ohos.permission.BACKUP + * @param { string[] } bundlesToBackup Bundles to backup. + * @param { AsyncCallback } callback Asynchronous callback to be called when appendBundles has finished. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + appendBundles(bundlesToBackup: string[], callback: AsyncCallback): void; + + /** + * End Backup process + * + * @permission ohos.permission.BACKUP + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + release(): Promise; + } + + /** + * Control class for restore procedure. + * + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + class SessionRestore { + /** + * Constructor for obtaining the instance of the SessionBackup class. + * + * @permission ohos.permission.BACKUP + * @param { GeneralCallbacks } callbacks Callbacks to be registered for the restore. + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + constructor(callbacks: GeneralCallbacks); + + /** + * Append new bundles to be restore up during the restore. + * + * @permission ohos.permission.BACKUP + * @param { number } remoteCapabilitiesFd Opened JSON file that stores remote device capabilities. + * You can use the getLocalCapabilities method to obtain the value. + * @param { string[] } bundlesToBackup Bundles to restore. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + /** + * Append new bundles and restoreInfos to be restore up during the restore. + * + * @permission ohos.permission.BACKUP + * @param { number } remoteCapabilitiesFd Opened JSON file that stores remote device capabilities. + * You can use the getLocalCapabilities method to obtain the value. + * @param { string[] } bundlesToBackup Bundles to restore. + * @param { string[] } [infos] infos to restore + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + appendBundles(remoteCapabilitiesFd: number, bundlesToBackup: string[], infos?: string[]): Promise; + + /** + * Append new bundles to be restore up during the restore. + * + * @permission ohos.permission.BACKUP + * @param { number } remoteCapabilitiesFd Opened JSON file that stores remote device capabilities. + * You can use the getLocalCapabilities method to obtain the value. + * @param { string[] } bundlesToBackup Bundles to restore. + * @param { AsyncCallback } callback Asynchronous callback to be called when appendBundles has finished. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + appendBundles(remoteCapabilitiesFd: number, bundlesToBackup: string[], callback: AsyncCallback): void; + + /** + * Publish the file handle to the backup service to make the service aware that the file's content is ready. + * This interface is part of the zero-copy feature. + * + * @permission ohos.permission.BACKUP + * @param { FileMeta } fileMeta Metadata of the file to be sent. Make sure that the backup framework holds + * this file by calling getFileHandle. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + publishFile(fileMeta: FileMeta): Promise; + + /** + * Publish the file handle to the backup service to make the service aware that the file's content is ready. + * This interface is part of the zero-copy feature. + * + * @permission ohos.permission.BACKUP + * @param { FileMeta } fileMeta Metadata of the file to be sent. Make sure that the backup framework holds + * this file by calling getFileHandle. + * @param { AsyncCallback } callback Asynchronous callback to be called when publishFile has finished. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + publishFile(fileMeta: FileMeta, callback: AsyncCallback): void; + + /** + * Request to get a shared file from the service. This interface is part of the zero-copy feature. + * Developers could get the file through onFileReady callback. + * When the client accomplished the file, use publishFile to publish. + * + * @permission ohos.permission.BACKUP + * @param { FileMeta } fileMeta Metadata of the file to be sent. Note that all the files should come + * from the backup procedure or the getLocalCapabilities method. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + getFileHandle(fileMeta: FileMeta): Promise; + + /** + * Request to get a shared file from the service. This interface is part of the zero-copy feature. + * Developers could get the file through onFileReady callback. + * When the client accomplished the file, use publishFile to publish. + * + * @permission ohos.permission.BACKUP + * @param { FileMeta } fileMeta Metadata of the file to be sent. Note that all the files should come + * from the backup procedure or the getLocalCapabilities method. + * @param { AsyncCallback } callback Asynchronous callback to be called when getFileHandle has finished. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 10 + */ + getFileHandle(fileMeta: FileMeta, callback: AsyncCallback): void; + + /** + * End restore process + * + * @permission ohos.permission.BACKUP + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + release(): Promise; + } + + /** + * Control class for incremental backup procedure. + * + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + class IncrementalBackupSession { + /** + * Constructor for obtaining the instance of the IncrementalBackupSession class. + * + * @permission ohos.permission.BACKUP + * @param { GeneralCallbacks } callbacks Callbacks to be registered for the backup. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + constructor(callbacks: GeneralCallbacks); + + /** + * Append new bundles to incremental backup. + * + * @permission ohos.permission.BACKUP + * @param { Array } bundlesToBackup Bundles to incremental backup. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + appendBundles(bundlesToBackup: Array): Promise; + + /** + * Append new bundles to incremental backup. + * + * @permission ohos.permission.BACKUP + * @param { Array } bundlesToAppend Bundles to incremental backup. + * @param { string[] } infos information of the bundlesToBackup + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed. This error code is usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3. Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + appendBundles(bundlesToAppend: Array, infos: string[]): Promise; + + /** + * End backup process + * + * @permission ohos.permission.BACKUP + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. 3.Parameter verification failed. + * @throws { BusinessError } 13600001 - IPC error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.StorageService.Backup + * @systemapi + * @since 12 + */ + release(): Promise; + } +} +export default backup; diff --git a/api/@ohos.file.cloudSync.d.ts b/api/@ohos.file.cloudSync.d.ts index 897b8b0a470e21150787092281c60bcdbbfb7354..bc3bfe01419451c3f11fad95cc8c3b3374e040c4 100644 --- a/api/@ohos.file.cloudSync.d.ts +++ b/api/@ohos.file.cloudSync.d.ts @@ -25,7 +25,8 @@ import type { AsyncCallback, Callback } from './@ohos.base'; * * @namespace cloudSync * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace cloudSync { /** @@ -33,49 +34,56 @@ declare namespace cloudSync { * * @enum { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum SyncState { /** * Indicates that the sync state is uploading. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UPLOADING, /** * Indicates that the sync failed in upload processing. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UPLOAD_FAILED, /** * Indicates that the sync state is downloading. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOWNLOADING, /** * Indicates that the sync failed in download processing. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOWNLOAD_FAILED, /** * Indicates that the sync finish. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPLETED, /** * Indicates that the sync has been stopped. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STOPPED } @@ -85,63 +93,72 @@ declare namespace cloudSync { * * @enum { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum ErrorType { /** * No error occurred. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NO_ERROR, /** * Synchronization aborted due to network unavailable. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NETWORK_UNAVAILABLE, /** * Synchronization aborted due to wifi unavailable. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WIFI_UNAVAILABLE, /** * Synchronization aborted due to low capacity level. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BATTERY_LEVEL_LOW, /** * Synchronization aborted due to warning low capacity level. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BATTERY_LEVEL_WARNING, /** * Synchronization aborted due to cloud storage is full. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CLOUD_STORAGE_FULL, /** * Synchronization aborted due to local storage is full. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCAL_STORAGE_FULL, /** * Synchronization aborted due to device temperature is too high. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEVICE_TEMPERATURE_TOO_HIGH, @@ -152,7 +169,8 @@ declare namespace cloudSync { * * @interface SyncProgress * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface SyncProgress { /** @@ -160,7 +178,8 @@ declare namespace cloudSync { * * @type { SyncState } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ state: SyncState; /** @@ -168,7 +187,8 @@ declare namespace cloudSync { * * @type { ErrorType } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ error: ErrorType; } @@ -178,7 +198,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ class GallerySync { /** @@ -186,7 +207,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -202,7 +224,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ on(evt: 'progress', callback: (pg: SyncProgress) => void): void; /** @@ -218,7 +241,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(evt: 'progress', callback: (pg: SyncProgress) => void): void; /** @@ -233,7 +257,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(evt: 'progress'): void; /** @@ -249,7 +274,8 @@ declare namespace cloudSync { * @throws { BusinessError } 22400003 - Low battery level. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ start(): Promise; /** @@ -266,7 +292,8 @@ declare namespace cloudSync { * @throws { BusinessError } 22400003 - Low battery level. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ start(callback: AsyncCallback): void; /** @@ -279,7 +306,8 @@ declare namespace cloudSync { * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ stop(): Promise; /** @@ -293,7 +321,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ stop(callback: AsyncCallback): void; } @@ -303,35 +332,40 @@ declare namespace cloudSync { * * @enum { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum State { /** * Indicates that the download task in process now. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RUNNING, /** * Indicates that the download task finished. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ COMPLETED, /** * Indicates that the download task failed. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FAILED, /** * Indicates that the download task stopped. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STOPPED } @@ -341,49 +375,56 @@ declare namespace cloudSync { * * @enum { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum DownloadErrorType { /** * No error occurred. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NO_ERROR, /** * download aborted due to unknown error. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN_ERROR, /** * download aborted due to network unavailable. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NETWORK_UNAVAILABLE, /** * download aborted due to local storage is full. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LOCAL_STORAGE_FULL, /** * download aborted due to content is not found in the cloud. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_NOT_FOUND, /** * download aborted due to frequent user requests. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FREQUENT_USER_REQUESTS, } @@ -393,7 +434,8 @@ declare namespace cloudSync { * * @interface DownloadProgress * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface DownloadProgress { /** @@ -401,7 +443,8 @@ declare namespace cloudSync { * * @type { State } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ state: State; /** @@ -409,7 +452,8 @@ declare namespace cloudSync { * * @type { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ processed: number; /** @@ -417,7 +461,8 @@ declare namespace cloudSync { * * @type { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size: number; /** @@ -425,7 +470,8 @@ declare namespace cloudSync { * * @type { string } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; /** @@ -433,7 +479,8 @@ declare namespace cloudSync { * * @type { DownloadErrorType } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ error: DownloadErrorType; } @@ -443,7 +490,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ class Download { /** @@ -451,7 +499,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -467,7 +516,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ on(evt: 'progress', callback: (pg: DownloadProgress) => void): void; /** @@ -483,7 +533,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(evt: 'progress', callback: (pg: DownloadProgress) => void): void; /** @@ -498,7 +549,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(evt: 'progress'): void; /** @@ -515,7 +567,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900025 - No space left on device. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ start(uri: string): Promise; /** @@ -532,7 +585,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900025 - No space left on device. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ start(uri: string, callback: AsyncCallback): void; /** @@ -547,7 +601,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ stop(uri: string): Promise; /** @@ -562,7 +617,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ stop(uri: string, callback: AsyncCallback): void; } @@ -571,7 +627,8 @@ declare namespace cloudSync { * FileSync object. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class FileSync { /** @@ -579,7 +636,8 @@ declare namespace cloudSync { * * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -591,7 +649,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(bundleName: string); /** @@ -603,7 +662,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(event: 'progress', callback: Callback): void; /** @@ -614,7 +674,8 @@ declare namespace cloudSync { * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(event: 'progress', callback?: Callback): void; /** @@ -627,7 +688,8 @@ declare namespace cloudSync { * @throws { BusinessError } 22400002 - Network unavailable. * @throws { BusinessError } 22400003 - Low battery level. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start(): Promise; /** @@ -640,7 +702,8 @@ declare namespace cloudSync { * @throws { BusinessError } 22400002 - Network unavailable. * @throws { BusinessError } 22400003 - Low battery level. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start(callback: AsyncCallback): void; /** @@ -650,7 +713,8 @@ declare namespace cloudSync { * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(): Promise; /** @@ -661,7 +725,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(callback: AsyncCallback): void; /** @@ -671,7 +736,8 @@ declare namespace cloudSync { * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLastSyncTime(): Promise; /** @@ -682,7 +748,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLastSyncTime(callback: AsyncCallback): void; } @@ -690,7 +757,8 @@ declare namespace cloudSync { * CloudFileCache object. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ class CloudFileCache { /** @@ -698,7 +766,8 @@ declare namespace cloudSync { * * @throws { BusinessError } 401 - The input parameter is invalid.Possible causes:Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -710,7 +779,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ on(event: 'progress', callback: Callback): void; /** @@ -722,7 +792,8 @@ declare namespace cloudSync { *
2.Incorrect parameter types. * @throws { BusinessError } 13600001 - IPC error * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ off(event: 'progress', callback?: Callback): void; @@ -738,7 +809,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900025 - No space left on device. * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ start(uri: string): Promise; /** @@ -753,7 +825,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900025 - No space left on device. * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ start(uri: string, callback: AsyncCallback): void; /** @@ -781,7 +854,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(uri: string, needClean?: boolean): Promise; /** @@ -795,7 +869,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900002 - No such file or directory. * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ stop(uri: string, callback: AsyncCallback): void; /** @@ -812,7 +887,8 @@ declare namespace cloudSync { * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cleanCache(uri: string): void; } @@ -823,7 +899,8 @@ declare namespace cloudSync { * @enum { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum FileSyncState { /** @@ -831,7 +908,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UPLOADING, /** @@ -839,7 +917,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DOWNLOADING, /** @@ -847,7 +926,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ COMPLETED, /** @@ -855,7 +935,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STOPPED, /** @@ -863,7 +944,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TO_BE_UPLOADED, /** @@ -871,7 +953,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UPLOAD_SUCCESS, /** @@ -879,7 +962,8 @@ declare namespace cloudSync { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UPLOAD_FAILURE, } @@ -899,7 +983,8 @@ declare namespace cloudSync { * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getFileSyncState(uri: Array): Promise>; /** @@ -917,7 +1002,8 @@ declare namespace cloudSync { * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getFileSyncState(uri: Array, callback: AsyncCallback>): void; /** @@ -937,7 +1023,8 @@ declare namespace cloudSync { * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getFileSyncState(uri: string): FileSyncState; /** @@ -953,7 +1040,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900012 - Permission denied * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function registerChange(uri: string, recursion: boolean, callback: Callback): void; /** @@ -967,7 +1055,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900012 - Permission denied * @throws { BusinessError } 14000002 - Invalid URI. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function unregisterChange(uri: string): void; @@ -976,35 +1065,40 @@ declare namespace cloudSync { * * @enum { number } NotifyType * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum NotifyType { /** * File has been newly created * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_ADDED, /** * File has been modified. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_MODIFIED, /** * File has been deleted. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_DELETED, /** * File has been renamed or moved. * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_RENAMED } @@ -1014,7 +1108,8 @@ declare namespace cloudSync { * * @interface ChangeData * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ChangeData { /** @@ -1022,7 +1117,8 @@ declare namespace cloudSync { * * @type {NotifyType} * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: NotifyType; /** @@ -1030,7 +1126,8 @@ declare namespace cloudSync { * * @type {Array} * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isDirectory: Array; /** @@ -1038,7 +1135,8 @@ declare namespace cloudSync { * * @type {Array} * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core - * @since 12 + * @since arkts{ '1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ uris: Array; } @@ -1055,7 +1153,8 @@ declare namespace cloudSync { * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ function optimizeStorage(): Promise; @@ -1074,7 +1173,8 @@ declare namespace cloudSync { * @throws { BusinessError } 22400006 - Other optimize task is running. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ function startOptimizeSpace(optimizePara: OptimizeSpaceParam, callback?: Callback): Promise; @@ -1088,7 +1188,8 @@ declare namespace cloudSync { * @throws { BusinessError } 22400005 - Inner error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ function stopOptimizeSpace(): void; @@ -1097,7 +1198,8 @@ declare namespace cloudSync { * @enum { number } OptimizeState * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ export enum OptimizeState { @@ -1105,7 +1207,8 @@ declare namespace cloudSync { * Indicates that the optimize space task in process now. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ RUNNING = 0, @@ -1113,7 +1216,8 @@ declare namespace cloudSync { * Indicates that the optimize space task finished successfully. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ COMPLETED = 1, @@ -1121,7 +1225,8 @@ declare namespace cloudSync { * Indicates that the optimize space task failed. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ FAILED = 2, @@ -1129,7 +1234,8 @@ declare namespace cloudSync { * Indicates that the optimize space task stopped. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ STOPPED = 3 } @@ -1139,9 +1245,10 @@ declare namespace cloudSync { * @typedef OptimizeSpaceProgress * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ - declare interface OptimizeSpaceProgress { + interface OptimizeSpaceProgress { /** * The current optimize space task state. @@ -1149,7 +1256,8 @@ declare namespace cloudSync { * @type { OptimizeState } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ state: OptimizeState; @@ -1159,7 +1267,8 @@ declare namespace cloudSync { * @type { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ progress: number; } @@ -1169,9 +1278,10 @@ declare namespace cloudSync { * @typedef OptimizeSpaceParam * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ - declare interface OptimizeSpaceParam { + interface OptimizeSpaceParam { /** * The total size(Unit:byte) of clean space. @@ -1179,7 +1289,8 @@ declare namespace cloudSync { * @type { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ totalSize: number; @@ -1189,7 +1300,8 @@ declare namespace cloudSync { * @type { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSync.Core * @systemapi - * @since 16 + * @since arkts{ '1.1':'17','1.2':'20'} + * @arkts 1.1&1.2 */ agingDays: number; } diff --git a/api/@ohos.file.cloudSyncManager.d.ts b/api/@ohos.file.cloudSyncManager.d.ts index b8869a41a0b3f48c950dfe1a9f5c05b1a628fbef..d4d50845324d15d30c75400aca1ec4616d51cafa 100644 --- a/api/@ohos.file.cloudSyncManager.d.ts +++ b/api/@ohos.file.cloudSyncManager.d.ts @@ -25,7 +25,8 @@ import type { AsyncCallback } from './@ohos.base'; * * @namespace cloudSyncManager * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace cloudSyncManager { /** @@ -41,7 +42,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean): Promise; @@ -58,7 +60,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function changeAppCloudSwitch( accountId: string, @@ -79,7 +82,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyDataChange(accountId: string, bundleName: string): Promise; @@ -95,7 +99,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyDataChange(accountId: string, bundleName: string, callback: AsyncCallback): void; @@ -112,7 +117,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function enableCloud(accountId: string, switches: Record): Promise; @@ -129,7 +135,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function enableCloud(accountId: string, switches: Record, callback: AsyncCallback): void; @@ -145,7 +152,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function disableCloud(accountId: string): Promise; @@ -161,7 +169,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function disableCloud(accountId: string, callback: AsyncCallback): void; @@ -171,7 +180,8 @@ declare namespace cloudSyncManager { * @enum { number } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum Action { /** @@ -179,7 +189,8 @@ declare namespace cloudSyncManager { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ RETAIN_DATA, @@ -188,7 +199,8 @@ declare namespace cloudSyncManager { * * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CLEAR_DATA } @@ -206,7 +218,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function clean(accountId: string, appActions: Record): Promise; @@ -223,7 +236,8 @@ declare namespace cloudSyncManager { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 10 + * @since arkts{ '1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function clean(accountId: string, appActions: Record, callback: AsyncCallback): void; @@ -241,7 +255,8 @@ declare namespace cloudSyncManager { * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyDataChange(userId: number, extraData: ExtraData): Promise; @@ -259,7 +274,8 @@ declare namespace cloudSyncManager { * @throws { BusinessError } 13600001 - IPC error. * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyDataChange(userId: number, extraData: ExtraData, callback: AsyncCallback): void; @@ -269,7 +285,8 @@ declare namespace cloudSyncManager { * @interface ExtraData * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ExtraData { /** @@ -278,7 +295,8 @@ declare namespace cloudSyncManager { * @type { string } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ eventId: string; /** @@ -287,7 +305,8 @@ declare namespace cloudSyncManager { * @type { string } * @syscap SystemCapability.FileManagement.DistributedFileService.CloudSyncManager * @systemapi - * @since 11 + * @since arkts{ '1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ extraData: string; } diff --git a/api/@ohos.file.environment.d.ts b/api/@ohos.file.environment.d.ts index 5d89e2c967fc799815049604852d2b59344036a2..cb5c78b0fd6a47e2f5d2dedc6d893ae01600dffb 100644 --- a/api/@ohos.file.environment.d.ts +++ b/api/@ohos.file.environment.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021-2023 Huawei Device Co., Ltd. + * 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 @@ -25,7 +25,8 @@ import type { AsyncCallback } from './@ohos.base'; * * @namespace Environment * @syscap SystemCapability.FileManagement.File.Environment - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace Environment { /** @@ -37,7 +38,8 @@ declare namespace Environment { * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.Environment * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getStorageDataDir(): Promise; @@ -50,7 +52,8 @@ declare namespace Environment { * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.Environment * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getStorageDataDir(callback: AsyncCallback): void; @@ -63,7 +66,8 @@ declare namespace Environment { * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.Environment * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserDataDir(): Promise; @@ -76,7 +80,8 @@ declare namespace Environment { * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.Environment * @systemapi - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserDataDir(callback: AsyncCallback): void; @@ -98,7 +103,8 @@ declare namespace Environment { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.File.Environment.FolderObtain - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserDownloadDir(): string; @@ -120,7 +126,8 @@ declare namespace Environment { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.File.Environment.FolderObtain - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserDesktopDir(): string; @@ -142,7 +149,8 @@ declare namespace Environment { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.File.Environment.FolderObtain - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserDocumentDir(): string; @@ -157,7 +165,8 @@ declare namespace Environment { * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.File.Environment.FolderObtain * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getExternalStorageDir(): string; @@ -172,7 +181,8 @@ declare namespace Environment { * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.File.Environment.FolderObtain * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserHomeDir(): string; } diff --git a/api/@ohos.file.fileAccess.d.ets b/api/@ohos.file.fileAccess.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..91c5e24b74627da6a764428d7a8f67a12ba7f794 --- /dev/null +++ b/api/@ohos.file.fileAccess.d.ets @@ -0,0 +1,2212 @@ +/* + * Copyright (c) 2022-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. + */ + +/** + * @file + * @kit CoreFileKit + */ + +import type { AsyncCallback, Callback } from './@ohos.base'; +import Want from './@ohos.app.ability.Want'; +import Context from './application/Context'; +import { Filter } from './@ohos.file.fs'; + +/** + * This module provides the capability to access user public files. + * + * @namespace fileAccess + * @syscap SystemCapability.FileManagement.UserFileService + * @since 9 + */ +declare namespace fileAccess { + /** + * Query the want information of HAP configured with fileaccess. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + * @param { AsyncCallback> } callback - The callback is used to return a Array object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export function getFileAccessAbilityInfo(callback: AsyncCallback>): void; + + /** + * Query the want information of HAP configured with fileaccess. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + * @returns { Promise> } Returns the wants. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export function getFileAccessAbilityInfo(): Promise>; + + /** + * Obtains the fileAccessHelper that connects all fileaccess servers in the system. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + * @param { Context } context Indicates the application context. + * @returns { FileAccessHelper } Returns the fileAccessHelper. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export function createFileAccessHelper(context: Context): FileAccessHelper; + + /** + * Obtains the fileAccessHelper that connects some specified fileaccess servers in the system. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER and ohos.permission.GET_BUNDLE_INFO_PRIVILEGED + * @param { Context } context Indicates the application context. + * @param { Array } wants Represents the connected data provider. + * @returns { FileAccessHelper } Returns the fileAccessHelper. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export function createFileAccessHelper(context: Context, wants: Array): FileAccessHelper; + + /** + * File Object + * + * @interface FileInfo + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export interface FileInfo { + /** + * Indicates the path of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + uri: string; + /** + * Indicates the relativePath of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + relativePath: string; + /** + * Indicates the name of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + fileName: string; + /** + * Indicates the mode of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + mode: number; + /** + * Indicates the size of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + size: number; + /** + * Indicates the mtime of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + mtime: number; + /** + * Indicates the mimeType of the file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + mimeType: string; + + /** + * List files in the current directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { Filter } filter Indicates the filter of file. + * @returns { FileIterator } Returns the FileIterator Object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + listFile(filter?: Filter): FileIterator; + + /** + * Recursively list all files in the current directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { Filter } filter Indicates the filter of file. + * @returns { FileIterator } Returns the FileIterator Object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + scanFile(filter?: Filter): FileIterator; + } + +// 定义返回值类型 + interface IteratorResult { + value: FileInfo; + done: boolean; + } + + /** + * FileIterator Object + * + * @interface FileIterator + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export interface FileIterator { + /** + * Get the next fileInfo. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @returns { object } Returns FileInfo Object and boolean flag. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + next(): IteratorResult; + } + + /** + * Root Object + * + * @interface RootInfo + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export interface RootInfo { + /** + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + deviceType: number; + /** + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + uri: string; + /** + * File or directory relative path + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + relativePath: string; + /** + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + displayName: string; + /** + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + deviceFlags: number; + + /** + * List files in the current directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { Filter } filter Indicates the filter of file. + * @returns { FileIterator } Returns the FileIterator Object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + listFile(filter?: Filter): FileIterator; + + /** + * Recursively list all files in the current directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { Filter } filter Indicates the filter of file. + * @returns { FileIterator } Returns the RootIterator Object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + scanFile(filter?: Filter): FileIterator; + } + + interface RootIterator_ { + value: RootInfo; + done: boolean; + } + + /** + * RootIterator Object + * + * @interface RootIterator + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export interface RootIterator { + /** + * Get a next RootInfo. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @returns { object } Returns RootInfo Object and boolean flag. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + next(): RootIterator_; + } + + /** + * Describes the return information of the copy operation. + * + * @interface CopyResult + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + export interface CopyResult { + /** + * Represents the source file or directory uri to be copied + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @stagemodeonly + * @since 10 + */ + sourceUri: string; + /** + * Represents a file or directory uri in the target folder + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @stagemodeonly + * @since 10 + */ + destUri: string; + /** + * Error code for failure to copy a file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @stagemodeonly + * @since 10 + */ + errCode: number; + /** + * Error message for failure to copy a file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @stagemodeonly + * @since 10 + */ + errMsg: string; + } + + /** + * OPENFLAGS represents the way to open the file. + * + * @enum { number } OPENFLAGS + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + export enum OPENFLAGS { + /** + * Open the file by Read-only mode. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + READ = 0o0, + + /** + * Open the file by Write-only mode. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + WRITE = 0o1, + + /** + * Open the file by Write-Read mode. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 9 + */ + WRITE_READ = 0o2 + } + + /** + * Property elements that support the file queries. + * + * @enum { string } FileKey + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + export enum FileKey { + /** + * The key represents the file name. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + DISPLAY_NAME = 'display_name', + + /** + * The key represents the date of the file creation. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + DATE_ADDED = 'date_added', + + /** + * The key represents the modify date of the file. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + DATE_MODIFIED = 'date_modified', + + /** + * The key represents the relative path. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + RELATIVE_PATH = 'relative_path', + + /** + * The key represents the file size. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + FILE_SIZE = 'size' + } + + /** + * Describes the notifyType. + * + * @enum { number } NotifyType + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + export enum NotifyType { + /** + * Type for add notification + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + NOTIFY_ADD, + + /** + * Type for delete notification + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + NOTIFY_DELETE, + + /** + * The file was moved into the monitored directory. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + NOTIFY_MOVED_TO, + + /** + * The file in the monitored directory was moved. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + NOTIFY_MOVED_FROM, + + /** + * The monitored file or directory was moved. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + NOTIFY_MOVE_SELF, + + /** + * Event type of device online. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + NOTIFY_DEVICE_ONLINE, + + /** + * Event type of device offline. + * + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + NOTIFY_DEVICE_OFFLINE + } + + /** + * The value of the notify callback function + * + * @interface NotifyMessage + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + export interface NotifyMessage { + /** + * Indicates the change type. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { NotifyType } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + type: NotifyType; + + /** + * Indicates the uris generated the change event. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { Array } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 10 + */ + uris: Array; + } + + /** + * Describes the return information of the move operation. + * + * @interface MoveResult + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + export interface MoveResult { + /** + * Indicates the source file or directory uri to be moved. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + sourceUri: string; + + /** + * Indicates the file or directory uri in the destination folder. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + destUri: string; + + /** + * Error code for failure to move a file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + errCode: number; + + /** + * Error message for failure to move a file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + errMsg: string; + } + + /** + * Indicates the root uri of the device + * + * @constant + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + const DEVICES_URI = 'file://docs'; + + /** + * FileAccessHelper Object + * + * @interface FileAccessHelper + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + export interface FileAccessHelper { + /** + * Open a file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Indicates the path of the file to open. + * @param { OPENFLAGS } flags Indicate options of opening a file. The default value is read-only. + * @returns { Promise } Returns the file descriptor. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + openFile(uri: string, flags: OPENFLAGS): Promise; + + /** + * Open a file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Indicates the path of the file to open. + * @param { OPENFLAGS } flags Indicate options of opening a file. The default value is read-only. + * @param { AsyncCallback } callback - The callback is used to return the file descriptor. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback): void; + + /** + * Create a file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Represents a specific parent directory. + * @param { string } displayName Indicates the new file name, and supports with suffix. + * @returns { Promise } Returns the new file's URI. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + createFile(uri: string, displayName: string): Promise; + + /** + * Create a file. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Represents a specific parent directory. + * @param { string } displayName Indicates the new file name, and supports with suffix. + * @param { AsyncCallback } callback - The callback is used to return the new file's URI. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + createFile(uri: string, displayName: string, callback: AsyncCallback): void; + + /** + * Create a Directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } parentUri Represents a specific parent directory. + * @param { string } displayName Indicates the new directory name. + * @returns { Promise } Returns the new directory's URI. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + mkDir(parentUri: string, displayName: string): Promise; + + /** + * Create a Directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } parentUri Represents a specific parent directory. + * @param { string } displayName Indicates the new directory name. + * @param { AsyncCallback } callback - The callback is used to return the new directory's URI. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + mkDir(parentUri: string, displayName: string, callback: AsyncCallback): void; + + /** + * Delete a file or delete a directory recursively. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Indicates the file or directory to be deleted. + * @returns { Promise } + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + delete(uri: string): Promise; + + /** + * Delete a file or delete a directory recursively. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Indicates the file or directory to be deleted. + * @param { AsyncCallback } callback + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + delete(uri: string, callback: AsyncCallback): void; + + /** + * Move a file or move a directory recursively. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceFile Indicates the file or directory to be moved. + * @param { string } destFile Represents the destination folder. + * @returns { Promise } Returns the generated new file or directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + move(sourceFile: string, destFile: string): Promise; + + /** + * Move a file or move a directory recursively. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceFile Indicates the file or directory to be moved. + * @param { string } destFile Represents the destination folder. + * @param { AsyncCallback } callback - The callback is used to return the generated new file or directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + move(sourceFile: string, destFile: string, callback: AsyncCallback): void; + + /** + * Copy file or directory in the promise way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be copied. + * @param { string } destUri - Represents the destination directory. + * @param { boolean } force - Optional parameter that determines whether to forcibly copy files. + * @returns { Promise> } Returns the file information where the error occurred. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + copy(sourceUri: string, destUri: string, force?: boolean): Promise>; + + /** + * Copy file or directory in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be copied. + * @param { string } destUri - Represents the destination directory. + * @param { AsyncCallback> } callback - The callback is used to return the file information where + * the error occurred. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + copy(sourceUri: string, destUri: string, callback: AsyncCallback>): void; + + /** + * Copy file or directory in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be copied. + * @param { string } destUri - Represents the destination directory. + * @param { boolean } force - Determines whether to forcibly copy files. + * @param { AsyncCallback> } callback - The callback is used to return the file information where + * the error occurred. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + copy(sourceUri: string, destUri: string, force: boolean, callback: AsyncCallback>): void; + + /** + * copy the file with the specified file name in the promise way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination folder. + * @param { string } fileName - Represents the name of the specified file. + * @returns { Promise } Returns the generated new file uri. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + copyFile(sourceUri: string, destUri: string, fileName: string): Promise; + + /** + * copy the file with the specified file name in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination folder. + * @param { string } fileName - Represents the name of the specified file. + * @param { AsyncCallback } callback - Returns the generated new file uri. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + copyFile(sourceUri: string, destUri: string, fileName: string, callback: AsyncCallback): void; + + /** + * Rename the selected file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Indicates the selected file or directory. + * @param { string } displayName Indicates the new directory or file name. + * @returns { Promise } Returns a URI representing the new file or directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + rename(uri: string, displayName: string): Promise; + + /** + * Rename the selected file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri Indicates the selected file or directory. + * @param { string } displayName Indicates the new directory or file name. + * @param { AsyncCallback } callback - The callback is used to return a URI representing the new file or + * directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + rename(uri: string, displayName: string, callback: AsyncCallback): void; + + /** + * Obtain the status of a file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceFileUri Indicates the selected file or directory. + * @returns { Promise } Returns whether it exists. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + access(sourceFileUri: string): Promise; + + /** + * Obtain the status of a file or directory. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceFileUri Indicates the selected file or directory. + * @param { AsyncCallback } callback - The callback is used to return whether it exists. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + access(sourceFileUri: string, callback: AsyncCallback): void; + + /** + * Query file related information by the uri in the promise way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri - Indicates the selected file or directory. + * @param { string } metaJson The json string includes query property. + * @returns { Promise } Returns the json string, includes query property and value. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + query(uri: string, metaJson: string): Promise; + + /** + * Query file related information by the uri in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri - Indicates the selected file or directory. + * @param { string } metaJson The json string includes query property. + * @param { AsyncCallback } callback - Returns the json string, includes query property and value. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + query(uri: string, metaJson: string, callback: AsyncCallback): void; + + /** + * Get a FileInfo by the uri in the promise way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri - Indicates the selected file or directory. + * @returns { Promise } Returns a FileInfo. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + getFileInfoFromUri(uri: string): Promise; + + /** + * Get a FileInfo by the uri in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri - Indicates the selected file or directory. + * @param { AsyncCallback } callback - The callback is used to return a fileinfo object. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + getFileInfoFromUri(uri: string, callback: AsyncCallback): void; + + /** + * Get a FileInfo by the relative path in the promise way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } relativePath - Indicates the selected file or directory. + * @returns { Promise } Returns a FileInfo. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + getFileInfoFromRelativePath(relativePath: string): Promise; + + /** + * Get a FileInfo by the relative path in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } relativePath - Indicates the selected file or directory. + * @param { AsyncCallback } callback - The callback is used to return a fileinfo object. + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + getFileInfoFromRelativePath(relativePath: string, callback: AsyncCallback): void; + + /** + * Get a RootIterator. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @returns { Promise } Returns a RootIterator. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + getRoots(): Promise; + + /** + * Get a RootIterator. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { AsyncCallback } callback - The callback is used to return a RootIterator. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14000001 - Invalid display name + * @throws { BusinessError } 14000002 - Invalid uri + * @throws { BusinessError } 14000003 - Invalid file extension + * @throws { BusinessError } 14000004 - File has been put into trash bin + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 9 + */ + getRoots(callback: AsyncCallback): void; + + /** + * Turn on monitor the specified uri. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri - Indicates the file or directory to be monitored. + * @param { boolean } notifyForDescendants - Indicates Whether to monitor changes in descendants. + * @param { Callback } callback - The callback is used to return the notify message. + * @throws { BusinessError } 14300002 - Invalid uri + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + registerObserver(uri: string, notifyForDescendants: boolean, callback: Callback): void; + + /** + * Turn off monitor the specified uri. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } uri - Indicates the file or directory the file that will cancel monitored. + * @param { Callback } callback - The object bound to the uri. + * @throws { BusinessError } 14300002 - Invalid uri + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @since 10 + */ + unregisterObserver(uri: string, callback?: Callback): void; + + /** + * Move file or directory in the promise way, And return the MoveResult. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination directory. + * @param { boolean } [force] - Optional parameter that determines whether to forcibly move files. + * @returns { Promise> } Returns the file information where the error occurred. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + moveItem(sourceUri: string, destUri: string, force?: boolean): Promise>; + + /** + * Move file or directory in the asyncCallback way, and return the MoveResult. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination directory. + * @param { AsyncCallback> } callback - The callback is used to return the file information where + * the error occurred. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + moveItem(sourceUri: string, destUri: string, callback: AsyncCallback>): void; + + /** + * Move file or directory in the asyncCallback way, and return the MoveResult. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination directory. + * @param { boolean } force - Determines whether to forcibly move files. + * @param { AsyncCallback> } callback - The callback is used to return the file information where + * the error occurred. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + moveItem(sourceUri: string, destUri: string, force: boolean, callback: AsyncCallback>): void; + + /** + * Move the file with the specified file name in the promise way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination folder. + * @param { string } fileName - Represents the name of the specified file. + * @returns { Promise } Returns the generated new file uri. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + moveFile(sourceUri: string, destUri: string, fileName: string): Promise; + + /** + * Move the file with the specified file name in the asyncCallback way. + * + * @permission ohos.permission.FILE_ACCESS_MANAGER + * @param { string } sourceUri - Indicates the file or directory to be moved. + * @param { string } destUri - Represents the destination folder. + * @param { string } fileName - Represents the name of the specified file. + * @param { AsyncCallback } callback - The callback is used to return the generated new file uri. + * @throws { BusinessError } 201 - Permission verification failed, usually the result returned by VerifyAccessToken. + * @throws { BusinessError } 202 - Permission verification failed, application which is not a system application + * uses system API. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300001 - IPC error + * @throws { BusinessError } 14300002 - Invalid uri + * @throws { BusinessError } 14300003 - Fail to get fileextension info + * @throws { BusinessError } 14300004 - Get wrong result + * @syscap SystemCapability.FileManagement.UserFileService + * @systemapi + * @StageModelOnly + * @since 11 + */ + moveFile(sourceUri: string, destUri: string, fileName: string, callback: AsyncCallback): void; + } +} + +export default fileAccess; diff --git a/api/@ohos.file.fileuri.d.ts b/api/@ohos.file.fileuri.d.ts index 10588c26a5c3c5d31f96a5b1eb3d9eb680c09645..db6a22dbf62666349477209a768322f12c5e6883 100644 --- a/api/@ohos.file.fileuri.d.ts +++ b/api/@ohos.file.fileuri.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022-2023 Huawei Device Co., Ltd. + * Copyright (C) 2022-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 @@ -16,6 +16,7 @@ /** * @file * @kit CoreFileKit + * @arkts 1.1&1.2 */ import uri from './@ohos.uri'; @@ -34,7 +35,8 @@ import uri from './@ohos.uri'; * @namespace fileUri * @syscap SystemCapability.FileManagement.AppFileService * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace fileUri { /** @@ -50,7 +52,8 @@ declare namespace fileUri { * @extends uri.URI * @syscap SystemCapability.FileManagement.AppFileService * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ class FileUri extends uri.URI { /** @@ -74,7 +77,8 @@ declare namespace fileUri { * @throws { BusinessError } 14300002 - Invalid uri * @syscap SystemCapability.FileManagement.AppFileService * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(uriOrPath: string); @@ -163,7 +167,8 @@ declare namespace fileUri { *
2.Incorrect parameter types. * @syscap SystemCapability.FileManagement.AppFileService * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUriFromPath(path: string): string; } diff --git a/api/@ohos.file.fs.d.ets b/api/@ohos.file.fs.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..e5e897722413bb2aa0637b546ecfce051b660cf0 --- /dev/null +++ b/api/@ohos.file.fs.d.ets @@ -0,0 +1,5101 @@ +/* + * Copyright (c) 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 CoreFileKit + * @arkts 1.2 + */ + +import { AsyncCallback } from './@ohos.base'; +import stream from './@ohos.util.stream'; + +/** + * FileIO + * + * @namespace fileIo + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +declare namespace fileIo { + + /** + * Mode Indicates the open flags. + * + * @namespace OpenMode + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + namespace OpenMode { + /** + * Read only Permission. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + const READ_ONLY = 0o0; + /** + * Write only Permission. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + const WRITE_ONLY = 0o1; + /** + * Write and Read Permission. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + const READ_WRITE = 0o2; + /** + * If not exist, create file. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + const CREATE = 0o100; + /** + * File truncate len 0. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + const TRUNC = 0o1000; + /** + * File append write. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + const APPEND = 0o2000; + /** + * File open in nonblocking mode. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + const NONBLOCK = 0o4000; + /** + * File is Dir. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + const DIR = 0o200000; + /** + * File is not symbolic link. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + const NOFOLLOW = 0o400000; + /** + * SYNC IO. + * + * @constant + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + const SYNC = 0o4010000; + } + +/** + * Access file. + * + * @param { string } path - path. + * @param { AccessModeType } [mode = fs.AccessModeType.EXIST] - accessibility mode. + * @returns { Promise } Returns the file is accessible or not in promise mode. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function access(path: string, mode?: AccessModeType): Promise; + +/** + * Access file. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - The callback is used to return the file is accessible or not. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function access(path: string, callback: AsyncCallback): void; + +/** + * Access file. + * + * @param { string } path - file path that needs to be checked whether the calling process can access. + * @param { AccessModeType } mode - accessibility mode. + * @param { AccessFlagType } flag - accessibility flag. + * @returns { Promise } Returns the file is accessible or not in promise mode. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function access(path: string, mode: AccessModeType, flag: AccessFlagType): Promise; + +/** + * + * Access file with sync interface. + * + * @param { string } path - path. + * @param { AccessModeType } [mode = fs.AccessModeType.EXIST] - accessibility mode. + * @returns { boolean } Returns the file is accessible or not. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function accessSync(path: string, mode?: AccessModeType): boolean; + +/** + * Access file with sync interface. + * + * @param { string } path - file path that needs to be checked whether the calling process can access. + * @param { AccessModeType } mode - accessibility mode. + * @param { AccessFlagType } flag - accessibility flag. + * @returns { boolean } Returns the file is accessible or not. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function accessSync(path: string, mode: AccessModeType, flag: AccessFlagType): boolean; + +/** + * Close file or fd. + * + * @param { number | File } file - file object or fd. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function close(file: number | File): Promise; + +/** + * Close file or fd. + * + * @param { number | File } file - file object or fd. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function close(file: number | File, callback: AsyncCallback): void; + +/** + * Close file or fd with sync interface. + * + * @param { number | File } file - file object or fd. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function closeSync(file: number | File): void; + +/** + * Copy file or directory. + * + * @param { string } srcUri - src uri. + * @param { string } destUri - dest uri. + * @param { CopyOptions } [options] - options. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied by the file system + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900021 - File table overflow + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copy(srcUri: string, destUri: string, options?: CopyOptions): Promise; + +/** + * Copy file or directory. + * + * @param { string } srcUri - src uri. + * @param { string } destUri - dest uri. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied by the file system + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900021 - File table overflow + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copy(srcUri: string, destUri: string, callback: AsyncCallback): void; + +/** + * Copy file or directory. + * + * @param { string } srcUri - src uri. + * @param { string } destUri - dest uri. + * @param { CopyOptions } options - options. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied by the file system + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900021 - File table overflow + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copy(srcUri: string, destUri: string, options: CopyOptions, callback: AsyncCallback): void; + +/** + * Copy directory. + * + * @param { string } src - source path. + * @param { string } dest - destination path. + * @param { number } [mode = 0] - mode. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copyDir(src: string, dest: string, mode?: number): Promise; + +/** + * Copy directory. + * + * @param { string } src - source path. + * @param { string } dest - destination path. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copyDir(src: string, dest: string, callback: AsyncCallback): void; + +/** + * Copy directory. + * + * @param { string } src - source path. + * @param { string } dest - destination path. + * @param { AsyncCallback> } callback - Return the callback function. + * @throws { BusinessError } 13900015 - File exists + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copyDir(src: string, dest: string, callback: AsyncCallback>): void; + +/** + * Copy directory. + * + * @param { string } src - source path. + * @param { string } dest - destination path. + * @param { number } mode - mode. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copyDir(src: string, dest: string, mode: number, callback: AsyncCallback): void; + +/** + * Copy directory. + * + * @param { string } src - source path. + * @param { string } dest - destination path. + * @param { number } mode - mode. + * @param { AsyncCallback> } callback - Return the callback function. + * @throws { BusinessError } 13900015 - File exists + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copyDir(src: string, dest: string, mode: number, callback: AsyncCallback>): void; + +/** + * Copy directory with sync interface. + * + * @param { string } src - source path. + * @param { string } dest - destination path. + * @param { number } [mode = 0] - mode. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function copyDirSync(src: string, dest: string, mode?: number): void; + +/** + * Copy file. + * + * @param { string | number } src - src. + * @param { string | number } dest - dest. + * @param { number } [mode = 0] - mode. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function copyFile(src: string | number, dest: string | number, mode?: number): Promise; + +/** + * Copy file. + * + * @param { string | number } src - src. + * @param { string | number } dest - dest. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function copyFile(src: string | number, dest: string | number, callback: AsyncCallback): void; + +/** + * Copy file. + * + * @param { string | number } src - src. + * @param { string | number } dest - dest. + * @param { number } [mode = 0] - mode. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function copyFile( + src: string | number, + dest: string | number, + mode: number, + callback: AsyncCallback +): void; + +/** + * Copy file with sync interface. + * + * @param { string | number } src - src. + * @param { string | number } dest - dest. + * @param { number } [mode = 0] - mode. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function copyFileSync(src: string | number, dest: string | number, mode?: number): void; + +/** + * Create class Stream. + * + * @param { string } path - path. + * @param { string } mode - mode. + * @returns { Promise } return Promise + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createStream(path: string, mode: string): Promise; + +/** + * Create class Stream. + * + * @param { string } path - path. + * @param { string } mode - mode. + * @param { AsyncCallback } callback - callback. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createStream(path: string, mode: string, callback: AsyncCallback): void; + +/** + * Create class Stream with sync interface. + * + * @param { string } path - path. + * @param { string } mode - mode. + * @returns { Stream } createStream + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createStreamSync(path: string, mode: string): Stream; + +/** + * Create class RandomAccessFile. + * + * @param { string | File } file - file path, object. + * @param { number } [mode = OpenMode.READ_ONLY] - mode. + * @param { RandomAccessFileOptions } [options] - RandomAccessFile options + * @returns { Promise } Returns the RandomAccessFile object which has been created in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createRandomAccessFile(file: string | File, mode?: number, + options?: RandomAccessFileOptions): Promise; + +/** + * Create class RandomAccessFile. + * + * @param { string | File } file - file path, object. + * @param { AsyncCallback } callback - The callback is used to return the RandomAccessFile object which has been created. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createRandomAccessFile(file: string | File, callback: AsyncCallback): void; + +/** + * Create class RandomAccessFile. + * + * @param { string | File } file - file path, object. + * @param { number } [mode = OpenMode.READ_ONLY] - mode. + * @param { AsyncCallback } callback - The callback is used to return the RandomAccessFile object which has been created. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createRandomAccessFile(file: string | File, mode: number, callback: AsyncCallback): void; + +/** + * Create class RandomAccessFile with sync interface. + * + * @param { string | File } file - file path, object. + * @param { number } [mode = OpenMode.READ_ONLY] - mode. + * @param { RandomAccessFileOptions } [options] - RandomAccessFile options + * @returns { RandomAccessFile } Returns the RandomAccessFile object which has been created. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createRandomAccessFileSync(file: string | File, mode?: number, + options?: RandomAccessFileOptions): RandomAccessFile; + +/** + * Create file read stream. + * + * @param { string } path - file path. + * @param { ReadStreamOptions } [options] - Optional parameters for ReadStream. + * @returns { ReadStream } Returns the ReadStream object which has been created. + * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createReadStream(path: string, options?: ReadStreamOptions): ReadStream; + +/** + * Create file write stream. + * + * @param { string } path - file path. + * @param { WriteStreamOptions } [options] - Optional parameters for ReadStream. + * @returns { WriteStream } Returns the WriteStream object which has been created. + * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createWriteStream(path: string, options?: WriteStreamOptions): WriteStream; + +/** + * Create watcher to listen for file changes. + * + * @param { string } path - path. + * @param { number } events - listened events. + * @param { WatchEventListener } listener - Callback to invoke when an event of the specified type occurs. + * @returns { Watcher } Returns the Watcher object which has been created. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900021 - File table overflow + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function createWatcher(path: string, events: number, listener: WatchEventListener): Watcher; + +/** + * Duplicate fd to File Object. + * + * @param { number } fd - fd. + * @returns { File } return File + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function dup(fd: number): File; + +/** + * Synchronize file metadata. + * + * @param { number } fd - fd. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function fdatasync(fd: number): Promise; + +/** + * Synchronize file metadata. + * + * @param { number } fd - fd. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function fdatasync(fd: number, callback: AsyncCallback): void; + +/** + * Synchronize file metadata with sync interface. + * + * @param { number } fd - fd. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function fdatasyncSync(fd: number): void; + +/** + * Create class Stream by using fd. + * + * @param { number } fd - fd. + * @param { string } mode - mode. + * @returns { Promise } Returns the Stream object in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function fdopenStream(fd: number, mode: string): Promise; + +/** + * Create class Stream by using fd. + * + * @param { number } fd - fd. + * @param { string } mode - mode. + * @param { AsyncCallback } callback - The callback is used to return the Stream object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function fdopenStream(fd: number, mode: string, callback: AsyncCallback): void; + +/** + * Create class Stream by using fd with sync interface. + * + * @param { number } fd - fd. + * @param { string } mode - mode. + * @returns { Stream } Returns the Stream object. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function fdopenStreamSync(fd: number, mode: string): Stream; + +/** + * Synchronize file. + * + * @param { number } fd - fd. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function fsync(fd: number): Promise; + +/** + * Synchronize file. + * + * @param { number } fd - fd. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function fsync(fd: number, callback: AsyncCallback): void; + +/** + * Synchronize file with sync interface. + * + * @param { number } fd - fd. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function fsyncSync(fd: number): void; + +/** + * List file. + * + * @param { string } path - path. + * @param { ListFileOptions } [options] - options. + * @returns { Promise } Returns an Array containing the name of files or directories that meet the filter criteria. + * If present, Include the subdirectory structure. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function listFile( + path: string, + options?: ListFileOptions +): Promise; + +/** + * List file. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - The callback is used to return an Array containing the name of files or directories + * that meet the filter criteria in promise mode. If present, Include the subdirectory structure. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function listFile(path: string, callback: AsyncCallback): void; + +/** + * List file. + * + * @param { string } path - path. + * @param { ListFileOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return an Array containing the name of files or directories + * that meet the filter criteria in promise mode. If present, Include the subdirectory structure. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function listFile( + path: string, + options: ListFileOptions, + callback: AsyncCallback +): void; + +/** + * List file with sync interface. + * + * @param { string } path - path. + * @param { ListFileOptions } [options] - options. + * @returns { string[] } Returns an Array containing the name of files or directories that meet the filter criteria. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function listFileSync( + path: string, + options?: ListFileOptions +): string[]; + +/** + * Reposition file offset. + * + * @param { number } fd - file descriptor. + * @param { number } offset - file offset. + * @param { WhenceType } [whence = WhenceType.SEEK_SET] - directive whence. + * @returns { number } Returns the file offset relative to starting position of file. + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900026 - Illegal seek + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function lseek(fd: number, offset: number, whence?: WhenceType): number; + +/** + * Stat link file. + * + * @param { string } path - path. + * @returns { Promise } Returns the Stat object in promise mode. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function lstat(path: string): Promise; + +/** + * Stat link file. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - The callback is used to return the Stat object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function lstat(path: string, callback: AsyncCallback): void; + +/** + * Stat link file with sync interface. + * + * @param { string } path - path. + * @returns { Stat } Returns the Stat object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function lstatSync(path: string): Stat; + +/** + * Make dir. + * + * @param { string } path - path. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function mkdir(path: string): Promise; + +/** + * Make dir. + * + * @param { string } path - path. + * @param { boolean } recursion - whether to recursively make directory. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +function mkdir(path: string, recursion: boolean): Promise; + +/** + * Make dir. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function mkdir(path: string, callback: AsyncCallback): void; + +/** + * Make dir. + * + * @param { string } path - path. + * @param { boolean } recursion - whether to recursively make directory. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +function mkdir(path: string, recursion: boolean, callback: AsyncCallback): void; + +/** + * Make dir with sync interface. + * + * @param { string } path - path. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function mkdirSync(path: string): void; + +/** + * Make dir with sync interface. + * + * @param { string } path - path. + * @param { boolean } recursion - whether to recursively make directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +function mkdirSync(path: string, recursion: boolean): void; + +/** + * Make temp dir. + * + * @param { string } prefix - dir prefix. + * @returns { Promise } Returns the path to the new directory in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function mkdtemp(prefix: string): Promise; + +/** + * Make temp dir. + * + * @param { string } prefix - dir prefix. + * @param { AsyncCallback } callback - The callback is used to return the path to the new directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function mkdtemp(prefix: string, callback: AsyncCallback): void; + +/** + * Make temp dir with sync interface. + * + * @param { string } prefix - dir prefix. + * @returns { string } Returns the path to the new directory. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function mkdtempSync(prefix: string): string; + +/** + * Move directory. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } [mode = 0] - move mode when duplicate file name exists. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function moveDir(src: string, dest: string, mode?: number): Promise; + +/** + * Move directory. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function moveDir(src: string, dest: string, callback: AsyncCallback): void; + +/** + * Move directory. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { AsyncCallback> } callback - Return the callback function. + * @throws { BusinessError } 13900015 - File exists + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function moveDir(src: string, dest: string, callback: AsyncCallback>): void; + +/** + * Move directory. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } mode - move mode when duplicate file name exists. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function moveDir(src: string, dest: string, mode: number, callback: AsyncCallback): void; + +/** + * Move directory. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } mode - move mode when duplicate file name exists. + * @param { AsyncCallback> } callback - Return the callback function. + * @throws { BusinessError } 13900015 - File exists + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function moveDir(src: string, dest: string, mode: number, callback: AsyncCallback>): void; + +/** + * Move directory with sync interface. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } [mode = 0] - move mode when duplicate file name exists. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function moveDirSync(src: string, dest: string, mode?: number): void; + +/** + * Move file. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } [mode = 0] - move mode when duplicate file name exists. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function moveFile(src: string, dest: string, mode?: number): Promise; + +/** + * Move file. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function moveFile(src: string, dest: string, callback: AsyncCallback): void; + +/** + * Move file. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } [mode = 0] - move mode when duplicate file name exists. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function moveFile(src: string, dest: string, mode: number, callback: AsyncCallback): void; + +/** + * Move file with sync interface. + * + * @param { string } src - source file path. + * @param { string } dest - destination file path. + * @param { number } [mode = 0] - move mode when duplicate file name exists. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function moveFileSync(src: string, dest: string, mode?: number): void; + +/** + * Open file. + * + * @param { string } path - path. + * @param { number } [mode = OpenMode.READ_ONLY] - mode. + * @returns { Promise } Returns the File object in Promise mode to record the file descriptor. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function open(path: string, mode?: number): Promise; + +/** + * Open file. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - The callback is used to return the File object to record the file descriptor. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function open(path: string, callback: AsyncCallback): void; + +/** + * Open file. + * + * @param { string } path - path. + * @param { number } [mode = OpenMode.READ_ONLY] - mode. + * @param { AsyncCallback } callback - The callback is used to return the File object to record the file descriptor. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function open(path: string, mode: number, callback: AsyncCallback): void; + +/** + * Open file with sync interface. + * + * @param { string } path - path. + * @param { number } [mode = OpenMode.READ_ONLY] - mode. + * @returns { File } Returns the File object to record the file descriptor. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900006 - No such device or address + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900017 - No such device + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900029 - Resource deadlock would occur + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function openSync(path: string, mode?: number): File; + +/** + * Read file. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @returns { Promise } Returns the number of file bytes read to buffer in promise mode. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function read( + fd: number, + buffer: ArrayBuffer, + options?: ReadOptions +): Promise; + +/** + * Read file. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer } buffer - buffer. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function read(fd: number, buffer: ArrayBuffer, callback: AsyncCallback): void; + +/** + * Read file. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function read( + fd: number, + buffer: ArrayBuffer, + options: ReadOptions, + callback: AsyncCallback +): void; + +/** + * Read file with sync interface. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @returns { number } Returns the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function readSync( + fd: number, + buffer: ArrayBuffer, + options?: ReadOptions +): number; + +/** + * Read content line by line. + * + * @param { string } filePath - file path. + * @param { Options } [options] - optional parameters + * @returns { Promise } Returns the iterator object in promise mode. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function readLines(filePath: string, options?: Options): Promise; + +/** + * Read content line by line. + * + * @param { string } filePath - file path. + * @param { AsyncCallback } callback - The callback is used to return the iterator object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function readLines(filePath: string, callback: AsyncCallback): void; + +/** + * Read content line by line. + * + * @param { string } filePath - file path. + * @param { Options } options - optional parameters + * @param { AsyncCallback } callback - The callback is used to return the iterator object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function readLines(filePath: string, options: Options, callback: AsyncCallback): void; + +/** + * Read content line by line with sync interface. + * + * @param { string } filePath - file path. + * @param { Options } [options] - optional parameters + * @returns { ReaderIterator } Returns the iterator object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function readLinesSync(filePath: string, options?: Options): ReaderIterator; + +/** + * Read text. + * + * @param { string } filePath - file path. + * @param { ReadTextOptions } [options] - options. + * @returns { Promise } Returns the contents of the read file in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function readText( + filePath: string, + options?: ReadTextOptions +): Promise; + +/** + * Read text. + * + * @param { string } filePath - file path. + * @param { AsyncCallback } callback - The callback is used to return the contents of the read file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function readText(filePath: string, callback: AsyncCallback): void; + +/** + * Read text. + * + * @param { string } filePath - file path. + * @param { ReadTextOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the contents of the read file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function readText( + filePath: string, + options: ReadTextOptions, + callback: AsyncCallback +): void; + +/** + * Read text with sync interface. + * + * @param { string } filePath - file path. + * @param { ReadTextOptions } [options] - options. + * @returns { string } Returns the contents of the read file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function readTextSync( + filePath: string, + options?: ReadTextOptions +): string; + +/** + * Rename file. + * + * @param { string } oldPath - oldPath. + * @param { string } newPath - newPath. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function rename(oldPath: string, newPath: string): Promise; + +/** + * Rename file. + * + * @param { string } oldPath - oldPath. + * @param { string } newPath - newPath. + * @param { AsyncCallback } callback - Returns the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function rename(oldPath: string, newPath: string, callback: AsyncCallback): void; + +/** + * Rename file with sync interface. + * + * @param { string } oldPath - oldPath. + * @param { string } newPath - newPath. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900016 - Cross-device link + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900028 - Too many links + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function renameSync(oldPath: string, newPath: string): void; + +/** + * Delete dir. + * + * @param { string } path - path. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system1 + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function rmdir(path: string): Promise; + +/** + * Delete dir. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system1 + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function rmdir(path: string, callback: AsyncCallback): void; + +/** + * Delete dir with sync interface. + * + * @param { string } path - path. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system1 + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900032 - Directory not empty + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function rmdirSync(path: string): void; + +/** + * Get file information. + * + * @param { string | number } file - path or file descriptor. + * @returns { Promise } Returns the Stat object in promise mode. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function stat(file: string | number): Promise; + +/** + * Get file information. + * + * @param { string | number } file - path or file descriptor. + * @param { AsyncCallback } callback - The callback is used to return the Stat object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function stat(file: string | number, callback: AsyncCallback): void; + +/** + * Get file information with sync interface. + * + * @param { string | number } file - path or file descriptor. + * @returns { Stat } Returns the Stat object. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function statSync(file: string | number): Stat; + +/** + * Link file. + * + * @param { string } target - target. + * @param { string } srcPath - srcPath. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function symlink(target: string, srcPath: string): Promise; + +/** + * Link file. + * + * @param { string } target - target. + * @param { string } srcPath - srcPath. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function symlink(target: string, srcPath: string, callback: AsyncCallback): void; + +/** + * Link file with sync interface. + * + * @param { string } target - target. + * @param { string } srcPath - srcPath. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function symlinkSync(target: string, srcPath: string): void; + +/** + * Truncate file. + * + * @param { string | number } file - path or file descriptor. + * @param { number } [len = 0] - len. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function truncate(file: string | number, len?: number): Promise; + +/** + * Truncate file. + * + * @param { string | number } file - path or file descriptor. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function truncate(file: string | number, callback: AsyncCallback): void; + +/** + * Truncate file. + * + * @param { string | number } file - path or file descriptor. + * @param { number } [len = 0] - len. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function truncate(file: string | number, len: number, callback: AsyncCallback): void; + +/** + * Truncate file with sync interface. + * + * @param { string | number } file - path or file descriptor. + * @param { number } [len = 0] - len. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900023 - Text file busy + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function truncateSync(file: string | number, len?: number): void; + +/** + * Delete file. + * + * @param { string } path - path. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function unlink(path: string): Promise; + +/** + * Delete file. + * + * @param { string } path - path. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function unlink(path: string, callback: AsyncCallback): void; + +/** + * Delete file with sync interface. + * + * @param { string } path - path. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900014 - Device or resource busy + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900033 - Too many symbolic links encountered + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function unlinkSync(path: string): void; + +/** + * Change file mtime. + * + * @param { string } path - path. + * @param { number } mtime - last modification time + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900027 - Read-only file system + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ +function utimes(path: string, mtime: number): void; + +/** + * Write file. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @returns { Promise } Returns the number of bytes written to the file in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function write( + fd: number, + buffer: ArrayBuffer | string, + options?: WriteOptions +): Promise; + +/** + * Write file. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer | string } buffer - buffer. + * @param { AsyncCallback } callback - The callback is used to return the number of bytes written to the file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function write(fd: number, buffer: ArrayBuffer | string, callback: AsyncCallback): void; + +/** + * Write file. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the number of bytes written to the file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function write( + fd: number, + buffer: ArrayBuffer | string, + options: WriteOptions, + callback: AsyncCallback +): void; + +/** + * Write file with sync interface. + * + * @param { number } fd - file descriptor. + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @returns { number } Returns the number of bytes written to the file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +function writeSync( + fd: number, + buffer: ArrayBuffer | string, + options?: WriteOptions +): number; + +/** + * Connect Distributed File System. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string } networkId - The networkId of device. + * @param { DfsListeners } listeners - The listeners of Distributed File System. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - The parameter check failed.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900045 - Connection failed. + * @throws { BusinessError } 13900046 - Software caused connection abort. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function connectDfs(networkId: string, listeners: DfsListeners): Promise; + +/** + * Disconnect Distributed File System. + * + * @permission ohos.permission.DISTRIBUTED_DATASYNC + * @param { string } networkId - The networkId of device. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 401 - The parameter check failed.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13600004 - Unmount failed. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function disconnectDfs(networkId: string): Promise; + +/** + * Set extended attributes information of the file. + * + * @param { string } path - path. + * @param { string } key - the key of extended attribute. + * @param { string } value - the value of extended attribute. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function setxattr(path: string, key: string, value: string): Promise; + +/** + * Set extended attributes information of the file. + * + * @param { string } path - path. + * @param { string } key - the key of extended attribute. + * @param { string } value - the value of extended attribute. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + +function setxattrSync(path: string, key: string, value: string): void; + +/** + * Get extended attributes information of the file. + * + * @param { string } path - path. + * @param { string } key - the key of extended attribute. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900007 - Arg list too long + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900037 - No data available + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function getxattr(path: string, key: string): Promise; + +/** + * Get extended attributes information of the file with sync interface. + * + * @param { string } path - path. + * @param { string } key - the key of extended attribute. + * @returns { string } Return the value of extended attribute. + * @throws { BusinessError } 401 - Parameter error.Possible causes:1.Mandatory parameters are left unspecified; + *
2.Incorrect parameter types. + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900007 - Arg list too long + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900031 - Function not implemented + * @throws { BusinessError } 13900037 - No data available + * @throws { BusinessError } 13900038 - Value too large for defined data type + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +function getxattrSync(path: string, key: string): string; + +/** + * Progress data of copyFile + * + * @typedef Progress + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +interface Progress { + /** + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly processedSize: number; + + /** + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly totalSize: number; +} + +/** + * Task signal. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +class TaskSignal { + /** + * Cancel the copy task in progress. + * + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900012 - Permission denied by the file system + * @throws { BusinessError } 13900043 - No task can be canceled. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + cancel(): void; + + /** + * Subscribe the cancel event of current task. + * + * @returns { Promise } Return the result of the cancel event. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + onCancel(): Promise; +} + +/** + * Get options of copy + * + * @typedef CopyOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +interface CopyOptions { + /** + * Listener of copy progress + * + * @type { ?ProgressListener } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + progressListener?: ProgressListener; + /** + * Cancel signal of copy. + * + * @type { ?TaskSignal } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + copySignal?: TaskSignal; +} + +/** + * Listener of copy progress. + * + * @typedef { function } ProgressListener + * @param { Progress } progress - indicates the progress data of copyFile + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +type ProgressListener = (progress: Progress) => void; + +/** + * File object. + * + * @interface File + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +interface File { + + /** + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + readonly fd: number; + + /** + * File path + * + * @type { string } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300002 - Invalid URI + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly path: string; + + /** + * File name + * + * @type { string } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly name: string; + + /** + * Get parent path of file. + * + * @returns { string } Return the parent path of file. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 14300002 - Invalid URI + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + getParent(): string; + + /** + * Lock file with blocking method. + * + * @param { boolean } exclusive - whether lock is exclusive. + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900043 - No record locks available + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + lock(exclusive?: boolean): Promise; + + /** + * Lock file with blocking method. + * + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900043 - No record locks available + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + lock(callback: AsyncCallback): void; + + /** + * Lock file with blocking method. + * + * @param { boolean } exclusive - whether lock is exclusive. + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900043 - No record locks available + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + lock(exclusive: boolean, callback: AsyncCallback): void; + + /** + * Try to lock file with returning results immediately. + * + * @param { boolean } exclusive - whether lock is exclusive. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900043 - No record locks available + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + tryLock(exclusive?: boolean): void; + + /** + * Unlock file. + * + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900043 - No record locks available + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + unlock(): void; +} + +/** + * RandomAccessFile object. + * + * @interface RandomAccessFile + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +interface RandomAccessFile { + + /** + * File descriptor + * + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly fd: number; + + /** + * File pointer + * + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly filePointer: number; + + /** + * Set file pointer. + * + * @param { number } filePointer - filePointer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + setFilePointer(filePointer: number): void; + + /** + * Close randomAccessFile with sync interface. + * + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + close(): void; + + /** + * Write randomAccessFile. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @returns { Promise } Returns the number of bytes written to the file in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + write( + buffer: ArrayBuffer | string, + options?: WriteOptions + ): Promise; + + /** + * Write randomAccessFile. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { AsyncCallback } callback - The callback is used to return the number of bytes written to the file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + write(buffer: ArrayBuffer | string, callback: AsyncCallback): void; + + /** + * Write randomAccessFile. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the number of bytes written to the file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + write( + buffer: ArrayBuffer | string, + options: WriteOptions, + callback: AsyncCallback + ): void; + + /** + * Write randomAccessFile with sync interface. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @returns { number } Returns the number of bytes written to the file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + writeSync( + buffer: ArrayBuffer | string, + options?: WriteOptions + ): number; + + /** + * Read randomAccessFile. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @returns { Promise } Returns the number of file bytes read to buffer in promise mode. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + read( + buffer: ArrayBuffer, + options?: ReadOptions + ): Promise; + + /** + * Read randomAccessFile. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + read(buffer: ArrayBuffer, callback: AsyncCallback): void; + + /** + * Read randomAccessFile. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + read( + buffer: ArrayBuffer, + options: ReadOptions, + callback: AsyncCallback + ): void; + + /** + * Read randomAccessFile with sync interface. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @returns { number } Returns the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readSync( + buffer: ArrayBuffer, + options?: ReadOptions + ): number; + + /** + * Generate read stream from RandomAccessFile object. + * + * @returns { ReadStream } Return ReadStream object. + * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + getReadStream(): ReadStream; + + /** + * Generate write stream from RandomAccessFile object. + * + * @returns { WriteStream } Return WriteStream object. + * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + getWriteStream(): WriteStream; +} + +/** + * File Read Stream. + * + * @extends stream.Readable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +class ReadStream extends stream.Readable { + /** + * The ReadStream constructor. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + constructor(); + + /** + * The Number of bytes read in the stream. + * + * @type { number } + * @readonly + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly bytesRead: number; + + /** + * The path of the file being read. + * + * @type { string } + * @readonly + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly path: string; + + /** + * Set the file position indicator for the read stream. + * + * @param { number } offset - file offset. + * @param { WhenceType } [whence = WhenceType.SEEK_SET] - directive whence. + * @returns { number } Returns the offset relative to starting position of stream. + * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900026 - Illegal seek + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + seek(offset: number, whence?: WhenceType): number; + + /** + * Close ReadStream with sync interface. + * + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + close(): void; +} + +/** + * File Write Stream. + * + * @extends stream.Writable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +class WriteStream extends stream.Writable { + /** + * The WriteStream constructor. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + constructor(); + + /** + * The Number of bytes written in the stream. + * + * @type { number } + * @readonly + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly bytesWritten: number; + + /** + * The path of the file being written. + * + * @type { string } + * @readonly + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly path: string; + + /** + * Set the file position indicator for the write stream. + * + * @param { number } offset - file offset. + * @param { WhenceType } [whence = WhenceType.SEEK_SET] - directive whence. + * @returns { number } Returns the offset relative to starting position of stream. + * @throws { BusinessError } 401 - Parameter error + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900026 - Illegal seek + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + seek(offset: number, whence?: WhenceType): number; + + /** + * Close WriteStream with sync interface. + * + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + close(): void; +} + +/** + * The AtomicFile class provides methods for performing atomic operations on files. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export class AtomicFile { + /** + * The AtomicFile constructor. + * @param { string } path file path. + * @throws { BusinessError } 401 Parameter error.Possible causes:1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + constructor(path: string); + + /** + * Get the File object from AtomicFile object. + * @returns { File } Returns the file object. + * @throws { BusinessError } 13900002 No such file or directory + * @throws { BusinessError } 13900005 IO error + * @throws { BusinessError } 13900012 Permission denied + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + getBaseFile(): File; + + /** + * Create the file read stream. + * @returns { ReadStream } Returns the file read stream. + * @throws { BusinessError } 13900001 Operation not permitted + * @throws { BusinessError } 13900002 No such file or directory + * @throws { BusinessError } 13900012 Permission denied + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + openRead(): ReadStream; + + /** + * Read the entire contents of the file. + * @returns { ArrayBuffer } Returns the ArrayBuffer of the file contents. + * @throws { BusinessError } 13900005 I/O error + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readFully(): ArrayBuffer; + + /** + * Create the file write stream. + * @returns { WriteStream } Returns the file write stream. + * @throws { BusinessError } 13900001 Operation not permitted + * @throws { BusinessError } 13900002 No such file or directory + * @throws { BusinessError } 13900012 Permission denied + * @throws { BusinessError } 13900027 Read-only file system + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + startWrite(): WriteStream; + + /** + * If the file is written successfully, the file is closed. + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + finishWrite(): void; + + /** + * If writing to the file fails, the file is rolled back. + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + failWrite(): void; + + /** + * Delete all file. + * @throws { BusinessError } 13900001 Operation not permitted + * @throws { BusinessError } 13900002 No such file or directory + * @throws { BusinessError } 13900012 Permission denied + * @throws { BusinessError } 13900027 Read-only file system + * @throws { BusinessError } 13900042 Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + delete(): void; +} + +/** + * Stat object. + * + * @interface Stat + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +interface Stat { + + /** + * @type { bigint } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + readonly ino: bigint; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + readonly mode: number; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + readonly uid: number; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + readonly gid: number; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + readonly size: number; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + readonly atime: number; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + readonly mtime: number; + + /** + * @type { number } + * @readonly + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + readonly ctime: number; + + /** + * Returns nanosecond of the access time. + * @type { bigint } + * @readonly + * @throws { BusinessError } 13900042 - Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly atimeNs?:bigint; + + /** + * Returns nanosecond of the modification time. + * @type { bigint } + * @readonly + * @throws { BusinessError } 13900042 - Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly mtimeNs?:bigint; + + /** + * Returns nanosecond of the change time. + * @type { bigint } + * @readonly + * @throws { BusinessError } 13900042 - Internal error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly ctimeNs?:bigint; + + /** + * + * @type { LocationType } + * @readonly + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly location: LocationType; + + /** + * Whether path/fd is block device. + * + * @returns { boolean } Returns whether the path/fd point to a block device or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + isBlockDevice(): boolean; + + /** + * Whether path/fd is character device. + * + * @returns { boolean } Returns whether the path/fd point to a character device or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + isCharacterDevice(): boolean; + + /** + * Whether path/fd is directory. + * + * @returns { boolean } Returns whether the path/fd point to a directory or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + isDirectory(): boolean; + + /** + * Whether path/fd is fifo. + * + * @returns { boolean } Returns whether the path/fd point to a fifo file or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + isFIFO(): boolean; + + /** + * Whether path/fd is file. + * + * @returns { boolean } Returns whether the path/fd point to a normal file or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + isFile(): boolean; + + /** + * Whether path/fd is socket. + * + * @returns { boolean } Returns whether the path/fd point to a socket file or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + isSocket(): boolean; + + /** + * Whether path/fd is symbolic link. + * + * @returns { boolean } Returns whether the path/fd point to a symbolic link or not. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @since 20 + */ + isSymbolicLink(): boolean; +} + +/** + * Stream object + * + * @interface Stream + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +interface Stream { + /** + * Close stream. + * + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + close(): Promise; + + /** + * Close stream. + * + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + close(callback: AsyncCallback): void; + + /** + * Close stream with sync interface. + * + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + closeSync(): void; + + /** + * Flush stream. + * + * @returns { Promise } The promise returned by the function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + flush(): Promise; + + /** + * Flush stream. + * + * @param { AsyncCallback } callback - Return the callback function. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + flush(callback: AsyncCallback): void; + + /** + * Flush stream with sync interface. + * + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + flushSync(): void; + + /** + * Write stream. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @returns { Promise } Returns the number of file bytes written to file in promise mode. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + write( + buffer: ArrayBuffer | string, + options?: WriteOptions + ): Promise; + + /** + * Write stream. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes written to file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + write(buffer: ArrayBuffer | string, callback: AsyncCallback): void; + + /** + * Write stream. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes written to file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + write( + buffer: ArrayBuffer | string, + options: WriteOptions, + callback: AsyncCallback + ): void; + + /** + * Write stream with sync interface. + * + * @param { ArrayBuffer | string } buffer - buffer. + * @param { WriteOptions } [options] - options. + * @returns { number } Returns the number of file bytes written to file. + * @throws { BusinessError } 13900001 - Operation not permitted + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900024 - File too large + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900041 - Quota exceeded + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + writeSync( + buffer: ArrayBuffer | string, + options?: WriteOptions + ): number; + + /** + * Read stream. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @returns { Promise } Returns the number of file bytes read to buffer in promise mode. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + read( + buffer: ArrayBuffer, + options?: ReadOptions + ): Promise; + + /** + * Read stream. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + read(buffer: ArrayBuffer, callback: AsyncCallback): void; + + /** + * Read stream. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @param { AsyncCallback } callback - The callback is used to return the number of file bytes read to buffer. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + read( + buffer: ArrayBuffer, + options: ReadOptions, + callback: AsyncCallback + ): void; + + /** + * Read stream with sync interface. + * + * @param { ArrayBuffer } buffer - buffer. + * @param { ReadOptions } [options] - options. + * @returns { number } Returns the number of file bytes read to file. + * @throws { BusinessError } 13900004 - Interrupted system call + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900010 - Try again + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900019 - Is a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900034 - Operation would block + * @throws { BusinessError } 13900042 - Unknown error + * @throws { BusinessError } 13900044 - Network is unreachable + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readSync( + buffer: ArrayBuffer, + options?: ReadOptions + ): number; +} + +/** + * Watcher object + * + * @interface Watcher + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +interface Watcher { + /** + * Start watcher. + * + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900021 - File table overflow + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + start(): void; + + /** + * Stop watcher. + * + * @throws { BusinessError } 13900002 - No such file or directory + * @throws { BusinessError } 13900008 - Bad file descriptor + * @throws { BusinessError } 13900011 - Out of memory + * @throws { BusinessError } 13900012 - Permission denied + * @throws { BusinessError } 13900013 - Bad address + * @throws { BusinessError } 13900015 - File exists + * @throws { BusinessError } 13900018 - Not a directory + * @throws { BusinessError } 13900020 - Invalid argument + * @throws { BusinessError } 13900021 - File table overflow + * @throws { BusinessError } 13900022 - Too many open files + * @throws { BusinessError } 13900025 - No space left on device + * @throws { BusinessError } 13900030 - File name too long + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + stop(): void; +} + +/** + * Enumeration of different types of whence. + * + * @enum { number } whence type + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +enum WhenceType { + /** + * Starting position of the file offset. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + SEEK_SET = 0, + + /** + * Current position of the file offset. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + SEEK_CUR = 1, + + /** + * Ending position of the file offset. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + SEEK_END = 2, +} + +/** + * Enumeration of different types of file location. + * + * @enum { number } location type + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +enum LocationType { + /** + * Local file. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + LOCAL = 1 << 0, + + /** + * Cloud file. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + CLOUD = 1 << 1, +} + +/** + * Enumeration of different types of access mode. + * + * @enum { number } access mode type + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +enum AccessModeType { + /** + * Check if the file exists. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + EXIST = 0, + + /** + * Check if the file has write permission. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + WRITE = 2, + + /** + * Check if the file has read permission. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + READ = 4, + + /** + * Check if the file has read and write permission. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + READ_WRITE = 6, +} + +/** + * Enumeration of different types of access flag. + * + * @enum { number } access flag type + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +enum AccessFlagType { + /** + * Check if the file is on the local. + * + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + LOCAL = 0, +} + +/** + * ReaderIterator object + * + * @interface ReaderIterator + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +interface ReaderIterator { + /** + * Get next result from the iterator. + * + * @returns { ReaderIteratorResult } Returns the result of reader iterator. + * @throws { BusinessError } 13900005 - I/O error + * @throws { BusinessError } 13900037 - No data available + * @throws { BusinessError } 13900042 - Unknown error + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + next(): ReaderIteratorResult; +} + +} + +/** + * Implements watcher event listening. + * + * @typedef { function } WatchEventListener + * @param { WatchEvent } event - Event type for the callback to invoke. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export type WatchEventListener = (event: WatchEvent) => void; + +/** + * Event Listening. + * + * @interface WatchEvent + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface WatchEvent { + /** + * File name. + * + * @type { string } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly fileName: string; + + /** + * Event happened. + * + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly event: number; + + /** + * Associated rename event. + * + * @type { number } + * @readonly + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + readonly cookie: number; +} + +/** + * Reader Iterator Result + * + * @interface ReaderIteratorResult + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface ReaderIteratorResult { + /** + * Whether reader iterator completes the traversal. + * + * @type { boolean } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + done: boolean; + + /** + * The value of reader iterator. + * + * @type { string } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + value: string; +} + +/** + * File filter type + * + * @interface Filter + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ +export interface Filter { + + /** + * The suffix of the file. + * + * @type { ?Array } + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + suffix?: Array; + + /** + * The display name of the file. + * + * @type { ?Array } + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + displayName?: Array; + + /** + * The mimetype of the file. + * + * @type { ?Array } + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + mimeType?: Array; + + /** + * The exceeding size of the file. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + fileSizeOver?: number; + + /** + * The last modification time of the file. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + lastModifiedAfter?: number; + + /** + * Whether to exclude media files. + * + * @type { ?boolean } + * @syscap SystemCapability.FileManagement.File.FileIO + * @crossplatform + * @atomicservice + * @since 20 + */ + excludeMedia?: boolean; +} + +/** + * Conflict Files type + * + * @interface ConflictFiles + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface ConflictFiles { + + /** + * The path of the source file. + * + * @type { string } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + srcFile: string; + + /** + * The path of the destination file. + * + * @type { string } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + destFile: string; +} + +/** + * Options type + * + * @interface Options + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface Options { + /** + * The encoding style. + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + encoding?: string; +} + +/** + * ReadOptions type + * + * @interface ReadOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +export interface ReadOptions { + /** + * The offset when reading the file. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + offset?: number; + /** + * The length for reading. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + length?: number; +} + +/** + * ReadTextOptions type + * + * @extends ReadOptions + * @interface ReadTextOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +export interface ReadTextOptions extends ReadOptions { + /** + * The encoding style when reading text. + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + encoding?: string; +} + +/** + * WriteOptions type + * + * @extends Options + * @interface WriteOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +export interface WriteOptions extends Options { + /** + * The offset when writing the file. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + offset?: number; + /** + * The length for writing. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + length?: number; +} + +/** + * ListFileOptions type + * + * @interface ListFileOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ +export interface ListFileOptions { + /** + * Whether to recursively list files. + * + * @type { ?boolean } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + recursion?: boolean; + + /** + * The number of files listed. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + listNum?: number; + + /** + * The filter of listing files. + * + * @type { ?Filter } + * @syscap SystemCapability.FileManagement.File.FileIO + * @atomicservice + * @since 20 + */ + filter?: Filter; +} + +/** + * RandomAccessFileOptions type + * + * @interface RandomAccessFileOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface RandomAccessFileOptions { + /** + * The starting position of file offset. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + start?: number; + + /** + * The ending position of file offset. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + end?: number; +} + +/** + * ReadStreamOptions type + * + * @interface ReadStreamOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface ReadStreamOptions { + /** + * The starting range for reading a file by stream. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + start?: number; + + /** + * The ending range for reading a file by stream. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + end?: number; +} + +/** + * WriteStreamOptions type + * + * @interface WriteStreamOptions + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface WriteStreamOptions { + /** + * The mode for creating write stream. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + mode?: number; + /** + * The starting range for writing a file by stream. + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + start?: number; +} + +/** + * The listeners of Distributed File System. + * + * @typedef DfsListeners + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +export interface DfsListeners { + /** + * The Listener of Distributed File System status + * + * @param { string } networkId - The networkId of device. + * @param { number } status - The status code of Distributed File System. + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ + onStatus(networkId: string, status: number): void; +} + +/** + * Task signal. + * @typedef { fileIo.TaskSignal } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +type TaskSignal = fileIo.TaskSignal; + +/** + * Watcher object + * @typedef { fileIo.Watcher } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +type Watcher = fileIo.Watcher; + +/** + * Watcher object + * @typedef { fileIo.AtomicFile } + * @syscap SystemCapability.FileManagement.File.FileIO + * @since 20 + */ +type AtomicFile = fileIo.AtomicFile; + +export default fileIo; +export {TaskSignal, Watcher, AtomicFile} diff --git a/api/@ohos.file.hash.d.ts b/api/@ohos.file.hash.d.ts index bd9f4e28b30543ef302d3e9b8c81bb1271c3e8f0..60bf4c044c2beb6e013f44376e4dbc91a62da437 100644 --- a/api/@ohos.file.hash.d.ts +++ b/api/@ohos.file.hash.d.ts @@ -34,7 +34,8 @@ import stream from './@ohos.util.stream'; * @namespace hash * @syscap SystemCapability.FileManagement.File.FileIO * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace hash { /** @@ -58,7 +59,8 @@ declare namespace hash { * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function hash(path: string, algorithm: string): Promise; @@ -83,7 +85,8 @@ declare namespace hash { * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function hash(path: string, algorithm: string, callback: AsyncCallback): void; @@ -92,7 +95,8 @@ declare namespace hash { * * @extends stream.Transform * @syscap SystemCapability.FileManagement.File.FileIO - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ class HashStream extends stream.Transform { /** @@ -102,7 +106,8 @@ declare namespace hash { * @throws { BusinessError } 401 - Parameter error * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ digest(): string; @@ -113,7 +118,8 @@ declare namespace hash { * @throws { BusinessError } 401 - Parameter error * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ update(data: ArrayBuffer): void; } diff --git a/api/@ohos.file.keyManager.d.ts b/api/@ohos.file.keyManager.d.ts index 058ad8dd99c542845ec486d06e0eba73e8c6f1a1..dd72db4b875eb397d4af88d695f124dc38bc3f65 100644 --- a/api/@ohos.file.keyManager.d.ts +++ b/api/@ohos.file.keyManager.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2024 Huawei Device Co., Ltd. + * Copyright (c) 2024-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 @@ -16,6 +16,7 @@ /** * @file * @kit CoreFileKit + * @arkts 1.1&1.2 */ /** @@ -23,7 +24,7 @@ * * @namespace keyManager * @syscap SystemCapability.FileManagement.StorageService.Encryption - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} */ declare namespace keyManager { /** @@ -40,7 +41,7 @@ declare namespace keyManager { * @throws { BusinessError } 13600009 - User ID out of range. Possible causes: input parameter userId < 100 or userId > 10736. * @syscap SystemCapability.FileManagement.StorageService.Encryption * @systemapi - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} */ function deactivateUserKey(userId: number):void; } diff --git a/api/@ohos.file.photoAccessHelper.d.ts b/api/@ohos.file.photoAccessHelper.d.ts index 325fd22620f941f7ac7165f0e7a35d18a0d4a5d7..21877e4f221eed58b1276bdfee1757ae148b9ff9 100644 --- a/api/@ohos.file.photoAccessHelper.d.ts +++ b/api/@ohos.file.photoAccessHelper.d.ts @@ -46,7 +46,8 @@ import type { CustomColors } from './@ohos.arkui.theme'; * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace photoAccessHelper { /** @@ -83,7 +84,8 @@ declare namespace photoAccessHelper { * @StageModelOnly * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getPhotoAccessHelper(context: Context): PhotoAccessHelper; @@ -109,7 +111,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PhotoType { /** @@ -131,7 +134,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1, /** @@ -153,7 +157,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO } @@ -172,7 +177,8 @@ declare namespace photoAccessHelper { * @enum { number } PhotoSubtype * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PhotoSubtype { /** @@ -187,7 +193,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, /** @@ -195,7 +202,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENSHOT = 1, /** @@ -203,7 +211,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MOVING_PHOTO = 3, /** @@ -211,7 +220,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BURST = 4, } @@ -221,21 +231,24 @@ declare namespace photoAccessHelper { * * @enum { number } DynamicRangeType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DynamicRangeType { /** * SDR(Standard-Dynamic Range) format * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SDR = 0, /** * HDR(High-Dynamic Range) format * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HDR = 1 } @@ -280,7 +293,8 @@ declare namespace photoAccessHelper { * * @enum { number } Photo asset position, such as local device or cloud * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ enum PositionType { /** @@ -294,7 +308,8 @@ declare namespace photoAccessHelper { * Asset exists only in local device * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ LOCAL = 1, /** @@ -308,7 +323,8 @@ declare namespace photoAccessHelper { * Asset exists only in cloud * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ CLOUD = 2, /** @@ -326,7 +342,8 @@ declare namespace photoAccessHelper { * @enum { number } AnalysisType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum AnalysisType { /** @@ -334,7 +351,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_AESTHETICS_SCORE = 0, /** @@ -342,7 +360,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_LABEL, /** @@ -350,7 +369,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_OCR, /** @@ -358,7 +378,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_FACE, /** @@ -366,7 +387,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_OBJECT, /** @@ -374,7 +396,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_RECOMMENDATION, /** @@ -382,7 +405,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_SEGMENTATION, /** @@ -390,7 +414,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_COMPOSITION, /** @@ -398,7 +423,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_SALIENCY, /** @@ -406,7 +432,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_DETAIL_ADDRESS, /** @@ -414,7 +441,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_HUMAN_FACE_TAG, /** @@ -422,7 +450,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_HEAD_POSITION, /** @@ -430,7 +459,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_BONE_POSE, /** @@ -438,7 +468,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_VIDEO_LABEL, /** @@ -446,7 +477,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_HIGHLIGHT, /** @@ -454,7 +486,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANALYSIS_MULTI_CROP, /** @@ -473,7 +506,8 @@ declare namespace photoAccessHelper { * @enum { number } RecommendationType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum RecommendationType { /** @@ -481,7 +515,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ QR_OR_BAR_CODE = 1, @@ -490,7 +525,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ QR_CODE = 2, @@ -499,7 +535,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BAR_CODE = 3, @@ -508,7 +545,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ID_CARD = 4, @@ -517,7 +555,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PROFILE_PICTURE = 5, @@ -526,7 +565,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PASSPORT = 6, @@ -535,7 +575,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BANK_CARD = 7, @@ -544,7 +585,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DRIVER_LICENSE = 8, @@ -553,7 +595,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DRIVING_LICENSE = 9, @@ -562,7 +605,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FEATURED_SINGLE_PORTRAIT = 10, @@ -581,14 +625,16 @@ declare namespace photoAccessHelper { * * @enum { number } DeliveryMode * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeliveryMode { /** * Fast delivery mode * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FAST_MODE = 0, @@ -596,7 +642,8 @@ declare namespace photoAccessHelper { * High quality delivery mode * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH_QUALITY_MODE = 1, @@ -604,7 +651,8 @@ declare namespace photoAccessHelper { * Balance delivery mode * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BALANCE_MODE = 2 } @@ -614,14 +662,16 @@ declare namespace photoAccessHelper { * * @enum { number } CompatibleMode * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ enum CompatibleMode { /** * Original format mode * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ORIGINAL_FORMAT_MODE = 0, @@ -629,7 +679,8 @@ declare namespace photoAccessHelper { * Compatible format mode. * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ COMPATIBLE_FORMAT_MODE = 1 } @@ -639,7 +690,8 @@ declare namespace photoAccessHelper { * * @interface MediaAssetProgressHandler * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ interface MediaAssetProgressHandler { /** @@ -647,7 +699,8 @@ declare namespace photoAccessHelper { * * @param { number } progress - the progress of required media asset data; from 0 to 100. * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ onProgress(progress: number): void; } @@ -658,7 +711,8 @@ declare namespace photoAccessHelper { * @enum { number } SourceMode * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum SourceMode { /** @@ -666,7 +720,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ORIGINAL_MODE = 0, @@ -675,7 +730,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ EDITED_MODE = 1 } @@ -686,7 +742,8 @@ declare namespace photoAccessHelper { * @enum { number } PhotoPermissionType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PhotoPermissionType { /** @@ -694,7 +751,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TEMPORARY_READ_IMAGEVIDEO = 0, @@ -703,7 +761,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PERSISTENT_READ_IMAGEVIDEO = 1 } @@ -714,7 +773,8 @@ declare namespace photoAccessHelper { * @enum { number } HideSensitiveType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum HideSensitiveType { /** @@ -722,7 +782,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIDE_LOCATION_AND_SHOOTING_PARAM = 0, @@ -731,7 +792,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIDE_LOCATION_ONLY = 1, @@ -740,7 +802,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIDE_SHOOTING_PARAM_ONLY = 2, @@ -749,7 +812,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NO_HIDE_SENSITIVE_TYPE = 3 } @@ -760,7 +824,8 @@ declare namespace photoAccessHelper { * @enum { number } AuthorizationMode * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AuthorizationMode { /** @@ -768,7 +833,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHORT_TIME_AUTHORIZATION = 0 } @@ -779,7 +845,8 @@ declare namespace photoAccessHelper { * @enum { number } WatermarkType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum WatermarkType { /** @@ -787,7 +854,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -796,7 +864,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ BRAND_COMMON = 1, @@ -805,7 +874,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ COMMON = 2, @@ -814,7 +884,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ BRAND = 3, } @@ -825,7 +896,8 @@ declare namespace photoAccessHelper { * @enum { number } CompleteButtonText * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum CompleteButtonText { /** @@ -833,7 +905,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_DONE = 0, /** @@ -841,7 +914,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_SEND = 1, @@ -850,7 +924,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_ADD = 2, } @@ -860,7 +935,8 @@ declare namespace photoAccessHelper { * * @interface RequestOptions * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestOptions { /** @@ -868,7 +944,8 @@ declare namespace photoAccessHelper { * * @type { DeliveryMode } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ deliveryMode: DeliveryMode; @@ -878,7 +955,8 @@ declare namespace photoAccessHelper { * @type { ?SourceMode } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sourceMode?: SourceMode; @@ -887,7 +965,8 @@ declare namespace photoAccessHelper { * * @type { ?CompatibleMode } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ compatibleMode?: CompatibleMode; @@ -896,7 +975,8 @@ declare namespace photoAccessHelper { * * @type { ?MediaAssetProgressHandler } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ mediaAssetProgressHandler?: MediaAssetProgressHandler; } @@ -906,7 +986,8 @@ declare namespace photoAccessHelper { * * @interface MediaAssetDataHandler * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface MediaAssetDataHandler { /** @@ -922,7 +1003,8 @@ declare namespace photoAccessHelper { * @param { T } data - the returned data of media asset * @param { Map } [map] - additional information for the data * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ onDataPrepared(data: T, map?: Map): void; } @@ -932,7 +1014,8 @@ declare namespace photoAccessHelper { * * @typedef QuickImageDataHandler * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface QuickImageDataHandler { /** @@ -942,7 +1025,8 @@ declare namespace photoAccessHelper { * @param { image.ImageSource } imageSource - the returned data of imageSource * @param { Map } map - additional information for the data * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ onDataPrepared(data: T, imageSource: image.ImageSource, map: Map): void; } @@ -953,7 +1037,8 @@ declare namespace photoAccessHelper { * @interface PhotoProxy * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PhotoProxy {} @@ -1060,6 +1145,24 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 12 */ + /** + * Request moving photo + * + * @permission ohos.permission.READ_IMAGEVIDEO + * @param { Context } context - Hap context information + * @param { PhotoAsset } asset - the photo asset requested + * @param { RequestOptions } requestOptions - the request options + * @param { MediaAssetDataHandler } dataHandler - data handler used to obtain moving photo when data is prepared + * @returns { Promise } Returns request id + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 801 - Capability not supported. + * @throws { BusinessError } 14000011 - System inner fail + * @static + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 18 + */ static requestMovingPhoto( context: Context, asset: PhotoAsset, @@ -1178,7 +1281,8 @@ declare namespace photoAccessHelper { * @typedef { number | string | boolean } MemberType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type MemberType = number | string | boolean; @@ -1204,7 +1308,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PhotoAsset { /** @@ -1222,14 +1327,14 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly uri: string; /** * Photo type, image or video * * @type { PhotoType } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ @@ -1237,17 +1342,16 @@ declare namespace photoAccessHelper { * Photo type, image or video * * @type { PhotoType } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly photoType: PhotoType; /** * Display name (with a file name extension) of the asset. * * @type { string } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ @@ -1255,10 +1359,10 @@ declare namespace photoAccessHelper { * Display name (with a file name extension) of the asset. * * @type { string } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly displayName: string; /** @@ -1284,7 +1388,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000014 - Member is not a valid PhotoKey * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ get(member: string): MemberType; /** @@ -1297,7 +1402,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000014 - Member is not a valid PhotoKey * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 * @example : set(PhotoKeys.TITLE, "newTitle"), call commitModify after set */ set(member: string, value: string): void; @@ -1328,7 +1434,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ commitModify(callback: AsyncCallback): void; /** @@ -1358,7 +1465,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ commitModify(): Promise; /** @@ -1466,7 +1574,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ getThumbnail(callback: AsyncCallback): void; /** @@ -1481,7 +1590,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ getThumbnail(size: image.Size, callback: AsyncCallback): void; /** @@ -1496,7 +1606,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ getThumbnail(size?: image.Size): Promise; /** @@ -1659,7 +1770,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getAnalysisData(analysisType: AnalysisType): Promise; /** @@ -1974,7 +2086,8 @@ declare namespace photoAccessHelper { * @enum { string } PhotoKeys * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PhotoKeys { /** @@ -1988,7 +2101,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ URI = 'uri', /** @@ -2002,7 +2116,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTO_TYPE = 'media_type', /** @@ -2016,7 +2131,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISPLAY_NAME = 'display_name', /** @@ -2030,7 +2146,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SIZE = 'size', /** @@ -2044,7 +2161,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_ADDED = 'date_added', /** @@ -2058,7 +2176,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_MODIFIED = 'date_modified', /** @@ -2072,7 +2191,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DURATION = 'duration', /** @@ -2086,7 +2206,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH = 'width', /** @@ -2100,7 +2221,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HEIGHT = 'height', /** @@ -2114,7 +2236,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TAKEN = 'date_taken', /** @@ -2128,7 +2251,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION = 'orientation', /** @@ -2142,7 +2266,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FAVORITE = 'is_favorite', /** @@ -2156,7 +2281,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TITLE = 'title', /** @@ -2165,12 +2291,14 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi * @since 10 + * @arkts 1.1&1.2 */ /** * Asset position, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ POSITION = 'position', /** @@ -2178,7 +2306,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TRASHED = 'date_trashed', /** @@ -2186,7 +2315,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ HIDDEN = 'hidden', /** @@ -2194,7 +2324,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ USER_COMMENT = 'user_comment', /** @@ -2202,7 +2333,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_SHOT_KEY = 'camera_shot_key', /** @@ -2210,7 +2342,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_YEAR = 'date_year', /** @@ -2218,7 +2351,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_MONTH = 'date_month', /** @@ -2226,7 +2360,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_DAY = 'date_day', /** @@ -2234,21 +2369,24 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PENDING = 'pending', /** * Creation time of the asset in milliseconds, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_ADDED_MS = 'date_added_ms', /** * Modified time of the asset in milliseconds, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_MODIFIED_MS = 'date_modified_ms', /** @@ -2256,14 +2394,16 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TRASHED_MS = 'date_trashed_ms', /** * Photo subtype of the asset, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTO_SUBTYPE = 'subtype', /** @@ -2271,28 +2411,32 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MOVING_PHOTO_EFFECT_MODE = 'moving_photo_effect_mode', /** * Dynamic range type of the asset, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DYNAMIC_RANGE_TYPE = 'dynamic_range_type', /** * Cover position of the asset, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COVER_POSITION = 'cover_position', /** * Unique uuid of the burst photos, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BURST_KEY = 'burst_key', /** @@ -2300,35 +2444,40 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ THUMBNAIL_READY = 'thumbnail_ready', /** * Width and height information of lcd picture, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LCD_SIZE = 'lcd_size', /** * Width and height information of thumbnail picture, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ THM_SIZE = 'thm_size', /** * Detail time of the asset, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DETAIL_TIME = 'detail_time', /** * Date taken of the asset in milliseconds, read only * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TAKEN_MS = 'date_taken_ms', /** @@ -2336,7 +2485,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CE_AVAILABLE = 'ce_available', /** @@ -2344,7 +2494,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ SUPPORTED_WATERMARK_TYPE = 'supported_watermark_type', /** @@ -2362,7 +2513,30 @@ declare namespace photoAccessHelper { * @systemapi * @since 18 */ - IS_CE_AUTO = 'is_auto' + IS_CE_AUTO = 'is_auto', + /** + * Owner album id of the asset, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + OWNER_ALBUM_ID = 'owner_album_id', + /** + * Recentshow state of the asset, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + IS_RECENT_SHOW = 'is_recent_show', + /** + * Suffix of the asset, read only + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @since 18 + */ + MEDIA_SUFFIX = 'media_suffix' } @@ -2379,7 +2553,8 @@ declare namespace photoAccessHelper { * @enum { string } AlbumKeys * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AlbumKeys { /** @@ -2393,7 +2568,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ URI = 'uri', /** @@ -2407,7 +2583,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALBUM_NAME = 'album_name', /** @@ -2417,7 +2594,23 @@ declare namespace photoAccessHelper { * @systemapi * @since 18 */ - ALBUM_LPATH = 'lpath' + ALBUM_LPATH = 'lpath', + /** + * Album bundle name + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + BUNDLE_NAME = 'bundle_name', + /** + * Modified date of the album + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + DATE_MODIFIED = 'date_modified', } /** @@ -2426,7 +2619,8 @@ declare namespace photoAccessHelper { * @enum { number } HiddenPhotosDisplayMode * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum HiddenPhotosDisplayMode { /** @@ -2434,7 +2628,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ASSETS_MODE, /** @@ -2442,7 +2637,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ALBUMS_MODE } @@ -2460,7 +2656,8 @@ declare namespace photoAccessHelper { * @interface FetchOptions * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FetchOptions { /** @@ -2476,7 +2673,8 @@ declare namespace photoAccessHelper { * @type { Array } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fetchColumns: Array; /** @@ -2492,7 +2690,8 @@ declare namespace photoAccessHelper { * @type { dataSharePredicates.DataSharePredicates } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ predicates: dataSharePredicates.DataSharePredicates; } @@ -2503,7 +2702,8 @@ declare namespace photoAccessHelper { * @interface PhotoCreateOptions * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PhotoCreateOptions { /** @@ -2512,7 +2712,8 @@ declare namespace photoAccessHelper { * @type { ?PhotoSubtype } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ subtype?: PhotoSubtype; /** @@ -2521,7 +2722,8 @@ declare namespace photoAccessHelper { * @type { ?string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ cameraShotKey?: string; } @@ -2532,7 +2734,8 @@ declare namespace photoAccessHelper { * @interface PhotoCreationConfig * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PhotoCreationConfig { /** @@ -2541,7 +2744,8 @@ declare namespace photoAccessHelper { * @type { ?string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ title?: string; @@ -2551,7 +2755,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fileNameExtension: string; @@ -2561,7 +2766,8 @@ declare namespace photoAccessHelper { * @type { PhotoType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ photoType: PhotoType; @@ -2571,7 +2777,8 @@ declare namespace photoAccessHelper { * @type { ?PhotoSubtype } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ subtype?: PhotoSubtype; } @@ -2589,7 +2796,8 @@ declare namespace photoAccessHelper { * @interface CreateOptions * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CreateOptions { /** @@ -2605,7 +2813,8 @@ declare namespace photoAccessHelper { * @type { ?string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title?: string; /** @@ -2614,7 +2823,8 @@ declare namespace photoAccessHelper { * @type { ?PhotoSubtype } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ subtype?: PhotoSubtype; } @@ -2625,7 +2835,8 @@ declare namespace photoAccessHelper { * @interface RequestPhotoOptions * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestPhotoOptions { /** @@ -2634,7 +2845,8 @@ declare namespace photoAccessHelper { * @type { ?image.Size } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ size?: image.Size; /** @@ -2643,11 +2855,59 @@ declare namespace photoAccessHelper { * @type { ?RequestPhotoType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ requestPhotoType?: RequestPhotoType; } + /** + * CreationSource of the asset + * + * @interface PhotoCreationSource + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + interface PhotoCreationSource { + /** + * BundleName of the asset + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + bundleName?: string; + /** + * AppName of the asset + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + appName?: string; + /** + * AppId of the asset + * + * @type { ?string } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + appId?: string; + /** + * TokenId of the asset + * + * @type { ?number } + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + tokenId?: number; + } + /** * The fetch result of assets or albums * @@ -2661,7 +2921,8 @@ declare namespace photoAccessHelper { * @interface FetchResult * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FetchResult { /** @@ -2685,7 +2946,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getCount(): number; /** @@ -2735,7 +2997,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getFirstObject(callback: AsyncCallback): void; /** @@ -2759,7 +3022,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getFirstObject(): Promise; /** @@ -2787,7 +3051,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getNextObject(callback: AsyncCallback): void; /** @@ -2815,7 +3080,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getNextObject(): Promise; /** @@ -2889,7 +3155,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getObjectByPosition(index: number, callback: AsyncCallback): void; /** @@ -2915,7 +3182,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getObjectByPosition(index: number): Promise; /** @@ -2939,7 +3207,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAllObjects(callback: AsyncCallback>): void; /** @@ -2963,7 +3232,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAllObjects(): Promise>; /** @@ -2985,7 +3255,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ close(): void; } @@ -3003,7 +3274,8 @@ declare namespace photoAccessHelper { * @enum { number } AlbumType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AlbumType { /** @@ -3017,7 +3289,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USER = 0, /** @@ -3031,15 +3304,25 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM = 1024, + /** + * Album created by app. + * + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + SOURCE = 2048, /** * Album created by smart abilities. * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SMART = 4096 } @@ -3057,7 +3340,8 @@ declare namespace photoAccessHelper { * @enum { number } AlbumSubtype * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AlbumSubtype { /** @@ -3071,7 +3355,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USER_GENERIC = 1, /** @@ -3085,7 +3370,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FAVORITE = 1025, /** @@ -3099,7 +3385,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO, /** @@ -3107,7 +3394,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ HIDDEN, /** @@ -3115,7 +3403,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ TRASH, /** @@ -3123,7 +3412,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENSHOT, /** @@ -3131,7 +3421,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA, /** @@ -3145,7 +3436,8 @@ declare namespace photoAccessHelper { * Image album * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1031, /** @@ -3153,7 +3445,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CLOUD_ENHANCEMENT = 1032, /** @@ -3161,7 +3454,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_GENERIC = 2049, /** @@ -3169,7 +3463,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CLASSIFY = 4097, /** @@ -3177,7 +3472,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ GEOGRAPHY_LOCATION = 4099, /** @@ -3185,7 +3481,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ GEOGRAPHY_CITY, /** @@ -3193,7 +3490,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SHOOTING_MODE, /** @@ -3201,7 +3499,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PORTRAIT, /** @@ -3209,7 +3508,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ GROUP_PHOTO, /** @@ -3217,7 +3517,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGHLIGHT = 4104, /** @@ -3225,7 +3526,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGHLIGHT_SUGGESTIONS, /** @@ -3239,7 +3541,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ANY = 2147483647 } @@ -3250,7 +3553,8 @@ declare namespace photoAccessHelper { * @enum { number } RequestPhotoType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum RequestPhotoType { /** @@ -3258,7 +3562,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ REQUEST_ALL_THUMBNAILS = 0, /** @@ -3266,7 +3571,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ REQUEST_FAST_THUMBNAIL, /** @@ -3274,7 +3580,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ REQUEST_QUALITY_THUMBNAIL } @@ -3292,14 +3599,14 @@ declare namespace photoAccessHelper { * @interface AbsAlbum * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AbsAlbum { /** * Album type * * @type { AlbumType } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ @@ -3307,17 +3614,16 @@ declare namespace photoAccessHelper { * Album type * * @type { AlbumType } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly albumType: AlbumType; /** * Album subtype * * @type { AlbumSubtype } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ @@ -3325,10 +3631,10 @@ declare namespace photoAccessHelper { * Album subtype * * @type { AlbumSubtype } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly albumSubtype: AlbumSubtype; /** @@ -3344,14 +3650,14 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ albumName: string; /** * Album uri. * * @type { string } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ @@ -3359,17 +3665,16 @@ declare namespace photoAccessHelper { * Album uri. * * @type { string } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly albumUri: string; /** * Number of assets in the album * * @type { number } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 */ @@ -3377,19 +3682,19 @@ declare namespace photoAccessHelper { * Number of assets in the album * * @type { number } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly count: number; /** * Cover uri for the album * * @type { string } - * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ readonly coverUri: string; /** @@ -3429,7 +3734,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAssets(options: FetchOptions, callback: AsyncCallback>): void; /** @@ -3459,7 +3765,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAssets(options: FetchOptions): Promise>; /** @@ -3475,7 +3782,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ getSharedPhotoAssets(options: FetchOptions): Array; } @@ -3483,7 +3791,6 @@ declare namespace photoAccessHelper { /** * Defines the album. * - * @extends AbsAlbum * @interface Album * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @since 10 @@ -3491,11 +3798,11 @@ declare namespace photoAccessHelper { /** * Defines the album. * - * @extends AbsAlbum * @interface Album * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface Album extends AbsAlbum { /** @@ -3513,7 +3820,8 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly imageCount?: number; /** @@ -3531,9 +3839,30 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly videoCount?: number; + /** + * Album dateAdded + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + readonly dateAdded?: number; + /** + * Album dateModified + * + * @type { ?number } + * @readonly + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + readonly dateModified?: number; /** * Modify metadata for the album * @@ -3545,7 +3874,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ commitModify(callback: AsyncCallback): void; /** @@ -3559,7 +3889,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ commitModify(): Promise; /** @@ -3755,7 +4086,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ getFaceId(): Promise; } @@ -3782,7 +4114,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PhotoAccessHelper { /** @@ -3812,7 +4145,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAssets(options: FetchOptions, callback: AsyncCallback>): void; /** @@ -3842,7 +4176,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAssets(options: FetchOptions): Promise>; /** @@ -3857,7 +4192,8 @@ declare namespace photoAccessHelper { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getBurstAssets(burstKey: string, options: FetchOptions): Promise>; /** @@ -3875,7 +4211,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(displayName: string, callback: AsyncCallback): void; /** @@ -3893,7 +4230,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(displayName: string): Promise; /** @@ -3912,7 +4250,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(displayName: string, options: PhotoCreateOptions): Promise; /** @@ -3931,7 +4270,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(displayName: string, options: PhotoCreateOptions, callback: AsyncCallback): void; /** @@ -3969,7 +4309,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(photoType: PhotoType, extension: string, options: CreateOptions, callback: AsyncCallback): void; /** @@ -4005,7 +4346,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(photoType: PhotoType, extension: string, callback: AsyncCallback): void; /** @@ -4043,7 +4385,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ createAsset(photoType: PhotoType, extension: string, options?: CreateOptions): Promise; /** @@ -4155,7 +4498,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAlbums( type: AlbumType, @@ -4192,7 +4536,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAlbums(type: AlbumType, subtype: AlbumSubtype, callback: AsyncCallback>): void; /** @@ -4226,7 +4571,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAlbums(type: AlbumType, subtype: AlbumSubtype, options?: FetchOptions): Promise>; /** @@ -4243,7 +4589,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail. * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getHiddenAlbums(mode: HiddenPhotosDisplayMode, options: FetchOptions, callback: AsyncCallback>): void; /** @@ -4259,7 +4606,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail. * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getHiddenAlbums(mode: HiddenPhotosDisplayMode, callback: AsyncCallback>): void; /** @@ -4276,7 +4624,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail. * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getHiddenAlbums(mode: HiddenPhotosDisplayMode, options?: FetchOptions): Promise>; /** @@ -4330,7 +4679,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900012 - Permission denied * @throws { BusinessError } 13900020 - Invalid argument * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ registerChange(uri: string, forChildUris: boolean, callback: Callback): void; /** @@ -4359,7 +4709,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900012 - Permission denied * @throws { BusinessError } 13900020 - Invalid argument * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ unRegisterChange(uri: string, callback?: Callback): void; /** @@ -4429,6 +4780,26 @@ declare namespace photoAccessHelper { * @since 15 */ createAssetsForApp(bundleName: string, appName: string, tokenId: number, photoCreationConfigs: Array): Promise>; + /** + * Create assets and grant save permission to the app which called the save dialog. + * + * @permission ohos.permission.WRITE_IMAGEVIDEO + * @param { string } bundleName - BundleName of the application which called the save dialog + * @param { string } appName - AppName of the application which called the save dialog + * @param { string } appId - AppId of the application which called the save dialog + * @param { Array } photoCreationConfigs - List of the photo asset creation configs + * @returns { Promise> } - Returns the media library file uri list to application which has been authorized + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - Internal system error + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + createAssetsForApp(bundleName: string, appName: string, appId: string, photoCreationConfigs: Array): Promise>; /** * Create asset and grant short term permission to the application. * @@ -4461,7 +4832,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ createAssetsForAppWithMode( bundleName: string, @@ -4500,7 +4872,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions, callback: AsyncCallback): void; /** @@ -4519,7 +4892,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ getPhotoIndex(photoUri: string, albumUri: string, options: FetchOptions): Promise; /** @@ -4531,7 +4905,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; /** @@ -4543,7 +4918,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 13900020 - Invalid argument * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; /** @@ -4559,7 +4935,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail. * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ saveFormInfo(info: FormInfo, callback: AsyncCallback): void; /** @@ -4575,7 +4952,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail. * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ saveFormInfo(info: FormInfo): Promise; /** @@ -4670,7 +5048,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ applyChanges(mediaChangeRequest: MediaChangeRequest): Promise; /** @@ -4683,7 +5062,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getIndexConstructProgress(): Promise; /** @@ -4705,7 +5085,12 @@ declare namespace photoAccessHelper { * @systemapi * @since 15 */ - grantPhotoUrisPermission(tokenId: number, uriList: Array, photoPermissionType: PhotoPermissionType, hideSensitiveType: HideSensitiveType): Promise; + grantPhotoUrisPermission( + tokenId: number, + uriList: Array, + photoPermissionType: PhotoPermissionType, + hideSensitiveType: HideSensitiveType + ): Promise; /** * Grant permission of asset to an APP. * @@ -4722,7 +5107,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ grantPhotoUriPermission(tokenId: number, uri: string, photoPermissionType: PhotoPermissionType, hideSensitiveType: HideSensitiveType): Promise; /** @@ -4772,7 +5158,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ stopThumbnailCreationTask(taskId: number): void; /** @@ -4818,7 +5205,43 @@ declare namespace photoAccessHelper { * @systemapi * @since 18 */ - startAssetAnalysis(type: AnalysisType, assetUris?: Array): Promise; + startAssetAnalysis(type: AnalysisType, assetUris?: Array): Promise; + /** + * Fetch albums by albumIds + * + * @permission ohos.permission.READ_IMAGEVIDEO + * @param { Array } albumIds - List of albumId + * @returns { Promise> } - Return the map of albums + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - System inner fail + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + getAlbumsByIds(albumIds: Array): Promise>; + /** + * Create assets in the album and grant save permission to the app + * + * @permission ohos.permission.WRITE_IMAGEVIDEO + * @param { PhotoCreationSource } source - photo asset creation source + * @param { string } albumUri - URI of the album. + * @param { boolean } isAuthorized - Is grant save permission to the app + * @param { Array } photoCreationConfigs - List of the photo asset creation configs + * @returns { Promise> } - Returns the media library file uri list to application which has been authorized + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - Internal system error + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + createAssetsForAppWithAlbum(source: PhotoCreationSource, albumUri: string, isAuthorized: boolean, + photoCreationConfigs: Array): Promise>; } /** @@ -4856,7 +5279,8 @@ declare namespace photoAccessHelper { * @interface FormInfo * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface FormInfo { /** @@ -4865,7 +5289,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ formId: string; /** @@ -4874,7 +5299,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; } @@ -4884,42 +5310,48 @@ declare namespace photoAccessHelper { * * @enum { number } NotifyType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum NotifyType { /** * Data(assets or albums) have been newly created * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_ADD, /** * Data(assets or albums) have been modified * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_UPDATE, /** * Data(assets or albums) have been removed * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_REMOVE, /** * Assets have been added to an album. * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_ALBUM_ADD_ASSET, /** * Assets have been removed from an album. * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFY_ALBUM_REMOVE_ASSET } @@ -4929,21 +5361,24 @@ declare namespace photoAccessHelper { * * @enum { string } DefaultChangeUri * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum DefaultChangeUri { /** * Uri for default PhotoAsset, use with forDescendant{true}, will receive all PhotoAsset's change notifications * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT_PHOTO_URI = 'file://media/Photo', /** * Uri for default Album, use with forDescendant{true}, will receive all Album's change notifications * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT_ALBUM_URI = 'file://media/PhotoAlbum', /** @@ -4951,7 +5386,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT_HIDDEN_ALBUM_URI = 'file://media/HiddenAlbum' } @@ -4961,7 +5397,8 @@ declare namespace photoAccessHelper { * * @interface ChangeData * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface ChangeData { /** @@ -4969,7 +5406,8 @@ declare namespace photoAccessHelper { * * @type { NotifyType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type: NotifyType; /** @@ -4977,7 +5415,8 @@ declare namespace photoAccessHelper { * * @type { Array } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ uris: Array; /** @@ -4985,7 +5424,8 @@ declare namespace photoAccessHelper { * * @type { Array } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ extraUris: Array; /** @@ -5039,7 +5479,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum PhotoViewMIMETypes { /** @@ -5061,7 +5502,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_TYPE = 'image/*', /** @@ -5083,7 +5525,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_TYPE = 'video/*', /** @@ -5105,7 +5548,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_VIDEO_TYPE = '*/*', @@ -5114,53 +5558,20 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MOVING_PHOTO_IMAGE_TYPE = 'image/movingPhoto' } - /** - * Enumeration type of single selection mode - * - * @enum { number } SingleSelectionMode - * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @atomicservice - * @since 18 - */ - export enum SingleSelectionMode { - /** - * browser mode - * - * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @atomicservice - * @since 18 - */ - BROWSER_MODE = 0, - /** - * select directly mode - * - * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @atomicservice - * @since 18 - */ - SELECT_MODE = 1, - /** - * browser and select mode - * - * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @atomicservice - * @since 18 - */ - BROWSER_AND_SELECT_MODE = 2 - } - /** * Class BaseSelectOptions, which is extracted from class PhotoSelectOptions * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class BaseSelectOptions { /** @@ -5301,16 +5712,6 @@ declare namespace photoAccessHelper { * @since 12 */ isPreviewForSingleSelectionSupported?: boolean; - - /** - * The mode of single selection - * - * @type { ?SingleSelectionMode } - * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @atomicservice - * @since 18 - */ - singleSelectionMode?: SingleSelectionMode; } /** @@ -5333,7 +5734,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class PhotoSelectOptions extends BaseSelectOptions { /** @@ -5402,7 +5804,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ class RecommendationOptions { /** @@ -5411,7 +5814,8 @@ declare namespace photoAccessHelper { * @type { ?RecommendationType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ recommendationType?: RecommendationType; @@ -5421,7 +5825,8 @@ declare namespace photoAccessHelper { * @type { ?TextContextInfo } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textContextInfo?: TextContextInfo; } @@ -5432,7 +5837,8 @@ declare namespace photoAccessHelper { * @interface TextContextInfo * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextContextInfo { /** @@ -5441,7 +5847,8 @@ declare namespace photoAccessHelper { * @type { ?string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ text?: string; } @@ -5465,7 +5872,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class PhotoSelectResult { /** @@ -5540,7 +5948,8 @@ declare namespace photoAccessHelper { * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class PhotoViewPicker { /** @@ -5660,7 +6069,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ class MediaAssetEditData { /** @@ -5684,7 +6094,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ compatibleFormat: string; @@ -5694,7 +6105,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ formatVersion: string; @@ -5704,7 +6116,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ data: string; } @@ -5715,7 +6128,8 @@ declare namespace photoAccessHelper { * @enum { number } ResourceType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum ResourceType { /** @@ -5723,7 +6137,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_RESOURCE = 1, @@ -5732,7 +6147,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_RESOURCE = 2, @@ -5741,7 +6157,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTO_PROXY = 3, @@ -5750,7 +6167,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ PRIVATE_MOVING_PHOTO_RESOURCE = 4, @@ -5769,14 +6187,16 @@ declare namespace photoAccessHelper { * * @enum { number } ImageFileType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum ImageFileType { /** * Jpeg type * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ JPEG = 1, @@ -5784,7 +6204,8 @@ declare namespace photoAccessHelper { * Heif type * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ HEIF = 2 } @@ -5795,7 +6216,8 @@ declare namespace photoAccessHelper { * @enum { number } MovingPhotoEffectMode * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MovingPhotoEffectMode { /** @@ -5803,7 +6225,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -5812,7 +6235,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BOUNCE_PLAY = 1, @@ -5821,7 +6245,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOOP_PLAY = 2, @@ -5830,7 +6255,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LONG_EXPOSURE = 3, @@ -5839,7 +6265,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MULTI_EXPOSURE = 4, @@ -5848,7 +6275,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CINEMA_GRAPH = 5, @@ -5857,7 +6285,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_ONLY = 10 } @@ -5868,7 +6297,8 @@ declare namespace photoAccessHelper { * @enum { number } VideoEnhancementType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoEnhancementType { /** @@ -5876,7 +6306,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_ENHANCEMENT_LOCAL = 0, @@ -5885,7 +6316,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_ENHANCEMENT_CLOUD = 1, @@ -5894,7 +6326,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_ENHANCEMENT_LOCAL_AND_CLOUD = 2 } @@ -5905,7 +6338,8 @@ declare namespace photoAccessHelper { * @interface MediaChangeRequest * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface MediaChangeRequest {} @@ -5915,7 +6349,8 @@ declare namespace photoAccessHelper { * @implements MediaChangeRequest * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ class MediaAssetChangeRequest implements MediaChangeRequest { /** @@ -5937,7 +6372,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(asset: PhotoAsset); @@ -5968,7 +6404,8 @@ declare namespace photoAccessHelper { * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static createImageAssetRequest(context: Context, fileUri: string): MediaAssetChangeRequest; @@ -5984,7 +6421,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static createVideoAssetRequest(context: Context, fileUri: string): MediaAssetChangeRequest; @@ -6003,7 +6441,8 @@ declare namespace photoAccessHelper { * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static createAssetRequest(context: Context, displayName: string, options?: PhotoCreateOptions): MediaAssetChangeRequest; @@ -6021,7 +6460,8 @@ declare namespace photoAccessHelper { * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static createAssetRequest(context: Context, photoType: PhotoType, extension: string, options?: CreateOptions): MediaAssetChangeRequest; @@ -6038,7 +6478,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static deleteAssets(context: Context, assets: Array): Promise; @@ -6056,7 +6497,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static deleteAssets(context: Context, uriList: Array): Promise; @@ -6079,7 +6521,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAsset(): PhotoAsset; @@ -6093,7 +6536,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setFavorite(favoriteState: boolean): void; @@ -6107,7 +6551,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setHidden(hiddenState: boolean): void; @@ -6121,7 +6566,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setUserComment(userComment: string): void; @@ -6136,7 +6582,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setLocation(longitude: number, latitude: number): void; @@ -6159,7 +6606,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setTitle(title: string): void; @@ -6187,7 +6635,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setEditData(editData: MediaAssetEditData): void; @@ -6202,7 +6651,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getWriteCacheHandler(): Promise; @@ -6218,7 +6668,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addResource(type: ResourceType, fileUri: string): void; @@ -6233,7 +6684,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addResource(type: ResourceType, data: ArrayBuffer): void; @@ -6249,7 +6701,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addResource(type: ResourceType, proxy: PhotoProxy): void; @@ -6263,7 +6716,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setCameraShotKey(cameraShotKey: string): void; @@ -6273,7 +6727,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ saveCameraPhoto(): void; @@ -6284,7 +6739,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ saveCameraPhoto(imageFileType: ImageFileType): void; @@ -6294,7 +6750,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ discardCameraPhoto(): void; @@ -6309,7 +6766,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setEffectMode(mode: MovingPhotoEffectMode): void; @@ -6337,7 +6795,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ setVideoEnhancementAttr(videoEnhancementType: VideoEnhancementType, photoId: string): void; @@ -6351,7 +6810,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ setSupportedWatermarkType(watermarkType: WatermarkType): void; @@ -6382,7 +6842,8 @@ declare namespace photoAccessHelper { * @implements MediaChangeRequest * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ class MediaAssetsChangeRequest implements MediaChangeRequest { /** @@ -6395,7 +6856,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(assets: Array); @@ -6409,7 +6871,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setFavorite(favoriteState: boolean): void; @@ -6423,7 +6886,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setHidden(hiddenState: boolean): void; @@ -6437,9 +6901,24 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setUserComment(userComment: string): void; + + /** + * Set recentShow state of the asset. + * + * @param { boolean } isRencentShow - the new recentShow state of the asset + * @throws { BusinessError } 202 - Called by non-system application + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @throws { BusinessError } 14000011 - System inner fail + * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core + * @systemapi + * @since 18 + */ + setIsRecentShow(isRencentShow: boolean): void; } /** @@ -6447,7 +6926,8 @@ declare namespace photoAccessHelper { * * @implements MediaChangeRequest * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ class MediaAlbumChangeRequest implements MediaChangeRequest { /** @@ -6458,7 +6938,8 @@ declare namespace photoAccessHelper { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(album: Album); @@ -6475,7 +6956,8 @@ declare namespace photoAccessHelper { * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static createAlbumRequest(context: Context, name: string): MediaAlbumChangeRequest; @@ -6494,7 +6976,8 @@ declare namespace photoAccessHelper { * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ static deleteAlbums(context: Context, albums: Array): Promise; @@ -6506,7 +6989,8 @@ declare namespace photoAccessHelper { *
2. Incorrect parameter types. * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getAlbum(): Album; @@ -6520,7 +7004,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setCoverUri(coverUri: string): void; @@ -6532,7 +7017,8 @@ declare namespace photoAccessHelper { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setAlbumName(name: string): void; @@ -6545,7 +7031,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addAssets(assets: Array): void; @@ -6558,7 +7045,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ removeAssets(assets: Array): void; @@ -6574,7 +7062,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ moveAssets(assets: Array, targetAlbum: Album): void; @@ -6589,7 +7078,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ recoverAssets(assets: Array): void; @@ -6604,7 +7094,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ deleteAssets(assets: Array): void; @@ -6617,7 +7108,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setIsMe(): void; @@ -6631,7 +7123,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setDisplayLevel(displayLevel: number): void; @@ -6646,7 +7139,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ dismissAssets(assets: Array): void; @@ -6661,7 +7155,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000016 - Operation Not Support * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mergeAlbum(target: Album): void; @@ -6675,7 +7170,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ placeBefore(album: Album): void; @@ -6683,12 +7179,12 @@ declare namespace photoAccessHelper { * Dismiss group photo album. * * @throws { BusinessError } 202 - Called by non-system application - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Incorrect parameter types. * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dismiss(): void; } @@ -6699,7 +7195,8 @@ declare namespace photoAccessHelper { * @interface SharedPhotoAsset * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface SharedPhotoAsset { /** @@ -6708,7 +7205,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ fileId: number; /** @@ -6717,7 +7215,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; /** @@ -6726,7 +7225,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ data: string; /** @@ -6735,7 +7235,8 @@ declare namespace photoAccessHelper { * @type { PhotoType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ mediaType: PhotoType; /** @@ -6744,7 +7245,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ displayName: string; /** @@ -6753,7 +7255,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ size: number; /** @@ -6762,7 +7265,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateAdded: number; /** @@ -6771,7 +7275,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateModified: number; /** @@ -6780,7 +7285,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ duration: number; /** @@ -6789,7 +7295,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; /** @@ -6798,7 +7305,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; /** @@ -6807,7 +7315,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateTaken: number; /** @@ -6816,7 +7325,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ orientation: number; /** @@ -6825,7 +7335,8 @@ declare namespace photoAccessHelper { * @type { boolean } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ isFavorite: boolean; /** @@ -6834,7 +7345,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ title: string; /** @@ -6843,7 +7355,8 @@ declare namespace photoAccessHelper { * @type { PositionType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ position: PositionType; /** @@ -6852,7 +7365,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateTrashed: number; /** @@ -6861,7 +7375,8 @@ declare namespace photoAccessHelper { * @type { boolean } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ hidden: boolean; /** @@ -6870,7 +7385,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ userComment: string; /** @@ -6879,7 +7395,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ cameraShotKey: string; /** @@ -6888,7 +7405,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateYear: string; /** @@ -6897,7 +7415,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateMonth: string; /** @@ -6906,7 +7425,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateDay: string; /** @@ -6915,7 +7435,8 @@ declare namespace photoAccessHelper { * @type { boolean } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ pending: boolean; /** @@ -6924,7 +7445,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateAddedMs: number; /** @@ -6933,7 +7455,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateModifiedMs: number; /** @@ -6942,7 +7465,8 @@ declare namespace photoAccessHelper { * @type { number } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dateTrashedMs: number; /** @@ -6951,16 +7475,18 @@ declare namespace photoAccessHelper { * @type { PhotoSubtype } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ subtype: PhotoSubtype; /** * Effect mode of moving photo - * + * * @type { MovingPhotoEffectMode } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ movingPhotoEffectMode: MovingPhotoEffectMode; /** @@ -6969,7 +7495,8 @@ declare namespace photoAccessHelper { * @type { DynamicRangeType } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ dynamicRangeType: DynamicRangeType; /** @@ -6978,7 +7505,8 @@ declare namespace photoAccessHelper { * @type { boolean } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ thumbnailReady: boolean; /** @@ -6987,7 +7515,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ lcdSize: string; /** @@ -6996,7 +7525,8 @@ declare namespace photoAccessHelper { * @type { string } * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ thmSize: string; /** @@ -7108,7 +7638,8 @@ declare namespace photoAccessHelper { * @interface MovingPhoto * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface MovingPhoto { /** @@ -7124,7 +7655,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ requestContent(imageFileUri: string, videoFileUri: string): Promise; @@ -7141,7 +7673,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ requestContent(resourceType: ResourceType, fileUri: string): Promise; @@ -7157,7 +7690,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ requestContent(resourceType: ResourceType): Promise; @@ -7170,7 +7704,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - System inner fail * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getUri(): string; } @@ -7181,7 +7716,8 @@ declare namespace photoAccessHelper { * @enum { number } HighlightAlbumInfoType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum HighlightAlbumInfoType { /** @@ -7189,7 +7725,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COVER_INFO = 0, /** @@ -7197,7 +7734,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAY_INFO } @@ -7208,7 +7746,8 @@ declare namespace photoAccessHelper { * @enum { number } HighlightUserActionType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum HighlightUserActionType { /** @@ -7216,7 +7755,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INSERTED_PIC_COUNT = 0, /** @@ -7224,7 +7764,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REMOVED_PIC_COUNT, /** @@ -7232,7 +7773,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHARED_SCREENSHOT_COUNT, /** @@ -7240,7 +7782,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHARED_COVER_COUNT, /** @@ -7248,7 +7791,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RENAMED_COUNT, /** @@ -7256,7 +7800,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CHANGED_COVER_COUNT, /** @@ -7264,7 +7809,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RENDER_VIEWED_TIMES = 100, /** @@ -7272,7 +7818,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RENDER_VIEWED_DURATION, /** @@ -7280,7 +7827,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ART_LAYOUT_VIEWED_TIMES, /** @@ -7288,7 +7836,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ART_LAYOUT_VIEWED_DURATION } @@ -7299,7 +7848,8 @@ declare namespace photoAccessHelper { * @enum { number } ThumbnailType * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum ThumbnailType { /** @@ -7307,7 +7857,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ LCD = 1, /** @@ -7315,7 +7866,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ THM = 2 } @@ -7405,7 +7957,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class HighlightAlbum { /** @@ -7418,7 +7971,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constructor(album: Album); @@ -7435,7 +7989,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getHighlightAlbumInfo(type: HighlightAlbumInfoType): Promise; @@ -7519,7 +8074,8 @@ declare namespace photoAccessHelper { * @enum { number } CloudEnhancementTaskStage * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum CloudEnhancementTaskStage { /** @@ -7527,7 +8083,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_EXCEPTION = -1, /** @@ -7535,7 +8092,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_PREPARING, /** @@ -7543,7 +8101,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_UPLOADING, /** @@ -7551,7 +8110,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_EXECUTING, /** @@ -7559,7 +8119,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_DOWNLOADING, /** @@ -7567,7 +8128,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_FAILED, /** @@ -7575,7 +8137,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ TASK_STAGE_COMPLETED } @@ -7586,7 +8149,8 @@ declare namespace photoAccessHelper { * @interface CloudEnhancementTaskState * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ interface CloudEnhancementTaskState { /** @@ -7596,7 +8160,8 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ readonly taskStage: CloudEnhancementTaskStage; /** @@ -7606,7 +8171,8 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ readonly transferredFileSize?: number; /** @@ -7616,7 +8182,8 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ readonly totalFileSize?: number; /** @@ -7626,7 +8193,8 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ readonly expectedDuration?: number; /** @@ -7636,7 +8204,8 @@ declare namespace photoAccessHelper { * @readonly * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ readonly statusCode?: number; } @@ -7646,7 +8215,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ class CloudEnhancement { /** @@ -7661,7 +8231,8 @@ declare namespace photoAccessHelper { * @static * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ static getCloudEnhancementInstance(context: Context): CloudEnhancement; @@ -7679,7 +8250,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ submitCloudEnhancementTasks(photoAssets: Array, hasCloudWatermark: boolean): Promise; @@ -7720,7 +8292,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ prioritizeCloudEnhancementTask(photoAsset: PhotoAsset): Promise; @@ -7737,7 +8310,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ cancelCloudEnhancementTasks(photoAssets: Array): Promise; @@ -7751,7 +8325,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ cancelAllCloudEnhancementTasks(): Promise; @@ -7782,7 +8357,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ syncCloudEnhancementTaskStatus(): Promise; @@ -7799,7 +8375,8 @@ declare namespace photoAccessHelper { * @throws { BusinessError } 14000011 - Internal system error * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ getCloudEnhancementPair(asset: PhotoAsset): Promise; } @@ -7810,7 +8387,8 @@ declare namespace photoAccessHelper { * @enum { number } CloudEnhancementState * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum CloudEnhancementState { /** @@ -7818,7 +8396,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ UNAVAILABLE = 0, /** @@ -7826,7 +8405,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ AVAILABLE, /** @@ -7834,7 +8414,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ EXECUTING, /** @@ -7842,7 +8423,8 @@ declare namespace photoAccessHelper { * * @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ COMPLETED } diff --git a/api/@ohos.file.picker.d.ts b/api/@ohos.file.picker.d.ts index 44bc880e29e3e7ec71ff79fc6c4aa16a09c8f4e7..8ce2f2d3ff890786ec82faf22f6331b7fc2c6f72 100644 --- a/api/@ohos.file.picker.d.ts +++ b/api/@ohos.file.picker.d.ts @@ -20,7 +20,7 @@ import { AsyncCallback, Callback } from './@ohos.base'; import Context from './application/Context'; -import window from "./@ohos.window" +import window from './@ohos.window'; import type { CustomColors } from './@ohos.arkui.theme'; /** * Provide the capabilities to use different pickers. diff --git a/api/@ohos.file.securityLabel.d.ts b/api/@ohos.file.securityLabel.d.ts index 6167dc92ace646abc9354557a9cc0b9780f5c409..1050c3b3240f692cb49c0268eb2f8613400aaf65 100644 --- a/api/@ohos.file.securityLabel.d.ts +++ b/api/@ohos.file.securityLabel.d.ts @@ -25,7 +25,8 @@ import type { AsyncCallback } from './@ohos.base'; * * @namespace securityLabel * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace securityLabel { /** @@ -33,7 +34,8 @@ declare namespace securityLabel { * * @typedef { 's0' | 's1' | 's2' | 's3' | 's4' } * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type DataLevel = 's0' | 's1' | 's2' | 's3' | 's4'; @@ -52,7 +54,8 @@ declare namespace securityLabel { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSecurityLabel(path: string, type: DataLevel): Promise; @@ -71,7 +74,8 @@ declare namespace securityLabel { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSecurityLabel(path: string, type: DataLevel, callback: AsyncCallback): void; @@ -89,7 +93,8 @@ declare namespace securityLabel { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSecurityLabelSync(path: string, type: DataLevel): void; @@ -107,7 +112,8 @@ declare namespace securityLabel { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSecurityLabel(path: string): Promise; @@ -125,7 +131,8 @@ declare namespace securityLabel { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSecurityLabel(path: string, callback: AsyncCallback): void; @@ -143,7 +150,8 @@ declare namespace securityLabel { * @throws { BusinessError } 13900041 - Quota exceeded * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSecurityLabelSync(path: string): string; } diff --git a/api/@ohos.file.statvfs.d.ts b/api/@ohos.file.statvfs.d.ts index b5f92e338e2b4f9babb3ef3203a2bdd913175fa6..9dd4b53226e8f0100d6688e4659aa44f62ccc81c 100644 --- a/api/@ohos.file.statvfs.d.ts +++ b/api/@ohos.file.statvfs.d.ts @@ -25,7 +25,8 @@ import type { AsyncCallback } from './@ohos.base'; * * @namespace statfs * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace statfs { /** @@ -47,7 +48,8 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFreeSize(path: string): Promise; @@ -70,7 +72,8 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFreeSize(path: string, callback: AsyncCallback): void; @@ -93,7 +96,8 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFreeSizeSync(path: string): number; @@ -116,7 +120,8 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTotalSize(path: string): Promise; @@ -139,7 +144,8 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTotalSize(path: string, callback: AsyncCallback): void; @@ -162,7 +168,8 @@ declare namespace statfs { * @throws { BusinessError } 13900038 - Value too large for defined data type * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.File.FileIO - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTotalSizeSync(path: string): number; } diff --git a/api/@ohos.file.storageStatistics.d.ts b/api/@ohos.file.storageStatistics.d.ts index 0bcb09387a7bd35c7c3b6d89f5f3b2ecf84a6964..2320239d5d044c198713ed94e7292e705dd01b64 100644 --- a/api/@ohos.file.storageStatistics.d.ts +++ b/api/@ohos.file.storageStatistics.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022-2023 Huawei Device Co., Ltd. + * Copyright (C) 2022-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 @@ -25,7 +25,8 @@ import { AsyncCallback, Callback } from './@ohos.base'; * * @namespace storageStatistics * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace storageStatistics { /** @@ -112,7 +113,8 @@ parameters are left unspecified; * * @interface BundleStats * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface BundleStats { /** @@ -120,7 +122,8 @@ parameters are left unspecified; * * @type { number } * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ appSize: number; @@ -129,7 +132,8 @@ parameters are left unspecified; * * @type { number } * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ cacheSize: number; @@ -138,7 +142,8 @@ parameters are left unspecified; * * @type { number } * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ dataSize: number; } @@ -225,7 +230,8 @@ parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentBundleStats(callback: AsyncCallback): void; @@ -238,7 +244,8 @@ parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentBundleStats(): Promise; @@ -282,7 +289,8 @@ parameters are left unspecified; * @interface StorageStats * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface StorageStats { /** @@ -291,7 +299,8 @@ parameters are left unspecified; * @type { number } * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ total: number; @@ -360,7 +369,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUserStorageStats(): Promise; @@ -378,7 +388,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUserStorageStats(callback: AsyncCallback): void; @@ -398,7 +409,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUserStorageStats(userId: number): Promise; @@ -418,7 +430,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getUserStorageStats(userId: number, callback: AsyncCallback): void; @@ -446,7 +459,8 @@ parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTotalSize(callback: AsyncCallback): void; @@ -472,7 +486,8 @@ parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function getTotalSize(): Promise; @@ -526,7 +541,8 @@ parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFreeSize(callback: AsyncCallback): void; @@ -552,7 +568,8 @@ parameters are left unspecified; * @throws { BusinessError } 13600001 - IPC error. * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.SpatialStatistics - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ function getFreeSize(): Promise; diff --git a/api/@ohos.file.volumeManager.d.ts b/api/@ohos.file.volumeManager.d.ts index 87377b26908cc65d6daff6a84b7ff7bbb5ff8c44..1b90ba7c3f8e84830c3161ba288037868bbb7ff5 100644 --- a/api/@ohos.file.volumeManager.d.ts +++ b/api/@ohos.file.volumeManager.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022-2023 Huawei Device Co., Ltd. + * Copyright (C) 2022-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 @@ -26,7 +26,8 @@ import { AsyncCallback, Callback } from './@ohos.base'; * @namespace volumeManager * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace volumeManager { /** @@ -35,7 +36,8 @@ declare namespace volumeManager { * @interface Volume * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Volume { /** @@ -54,7 +56,8 @@ declare namespace volumeManager { * @type { string } * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ uuid: string; @@ -74,7 +77,8 @@ declare namespace volumeManager { * @type { string } * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ description: string; @@ -131,7 +135,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllVolumes(callback: AsyncCallback>): void; @@ -148,7 +153,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllVolumes(): Promise>; @@ -260,7 +266,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getVolumeByUuid(uuid: string, callback: AsyncCallback): void; @@ -280,7 +287,8 @@ parameters are left unspecified; * @throws { BusinessError } 13900042 - Unknown error. * @syscap SystemCapability.FileManagement.StorageService.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getVolumeByUuid(uuid: string): Promise; diff --git a/api/@ohos.filemanagement.userFileManager.d.ts b/api/@ohos.filemanagement.userFileManager.d.ts index 4fe9440c8fbb1ca401c47f5eebcd0926e9f3317a..84267f223447e20852e9e2202b6d7b255a5c3aff 100644 --- a/api/@ohos.filemanagement.userFileManager.d.ts +++ b/api/@ohos.filemanagement.userFileManager.d.ts @@ -27,7 +27,8 @@ import dataSharePredicates from './@ohos.data.dataSharePredicates'; * @namespace userFileManager * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace userFileManager { /** @@ -38,7 +39,8 @@ declare namespace userFileManager { * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getUserFileMgr(context: Context): UserFileManager; @@ -48,7 +50,8 @@ declare namespace userFileManager { * @enum { number } FileType * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum FileType { /** @@ -56,7 +59,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE = 1, /** @@ -64,7 +68,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO, /** @@ -72,7 +77,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO } @@ -163,7 +169,8 @@ declare namespace userFileManager { * @typedef { 'deviceChange' | 'albumChange' | 'imageChange' | 'audioChange' | 'videoChange' | 'remoteFileChange' } ChangeEvent * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ type ChangeEvent = 'deviceChange' @@ -179,7 +186,8 @@ declare namespace userFileManager { * @interface FileAsset * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface FileAsset { /** @@ -513,7 +521,8 @@ declare namespace userFileManager { * @enum { string } ImageVideoKey * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum ImageVideoKey { /** @@ -521,7 +530,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ URI, /** @@ -529,7 +539,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ FILE_TYPE, /** @@ -537,7 +548,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DISPLAY_NAME, /** @@ -545,7 +557,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_ADDED, /** @@ -553,7 +566,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_MODIFIED, /** @@ -561,7 +575,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ TITLE, /** @@ -569,7 +584,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DURATION, /** @@ -577,7 +593,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ WIDTH, /** @@ -585,7 +602,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ HEIGHT, /** @@ -593,7 +611,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TAKEN, /** @@ -601,7 +620,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION, /** @@ -609,7 +629,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ FAVORITE, /** @@ -617,7 +638,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ POSITION, /** @@ -625,7 +647,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TRASHED, /** @@ -633,7 +656,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ HIDDEN, /** @@ -641,7 +665,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ USER_COMMENT, /** @@ -649,7 +674,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_SHOT_KEY } @@ -660,7 +686,8 @@ declare namespace userFileManager { * @enum { string } AlbumKey * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum AlbumKey { /** @@ -668,7 +695,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ URI, /** @@ -676,7 +704,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ FILE_TYPE, /** @@ -684,7 +713,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ ALBUM_NAME, /** @@ -692,7 +722,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_ADDED, /** @@ -700,7 +731,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_MODIFIED } @@ -711,7 +743,8 @@ declare namespace userFileManager { * @interface FetchOptions * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface FetchOptions { /** @@ -720,7 +753,8 @@ declare namespace userFileManager { * @type { Array } * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ fetchColumns: Array; /** @@ -729,7 +763,8 @@ declare namespace userFileManager { * @type { dataSharePredicates.DataSharePredicates } * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ predicates: dataSharePredicates.DataSharePredicates; } @@ -789,7 +824,8 @@ declare namespace userFileManager { * @interface FetchResult * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface FetchResult { /** @@ -1259,7 +1295,8 @@ declare namespace userFileManager { * @interface UserFileManager * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface UserFileManager { /** @@ -1271,7 +1308,8 @@ declare namespace userFileManager { * @throws { BusinessError } 13900020 - if type options is not FetchOptions * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getPhotoAssets(options: FetchOptions, callback: AsyncCallback>): void; /** @@ -1283,7 +1321,8 @@ declare namespace userFileManager { * @throws { BusinessError } 13900020 - if type options is not FetchOptions * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getPhotoAssets(options: FetchOptions): Promise>; /** @@ -1679,7 +1718,8 @@ declare namespace userFileManager { * @param { AsyncCallback } callback - No value returned * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; /** @@ -1688,7 +1728,8 @@ declare namespace userFileManager { * @returns { Promise } Return promise * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; } @@ -1861,7 +1902,8 @@ declare namespace userFileManager { * @enum { string } PrivateAlbumType * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrivateAlbumType { /** @@ -1869,7 +1911,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_FAVORITE, /** @@ -1877,7 +1920,8 @@ declare namespace userFileManager { * * @syscap SystemCapability.FileManagement.UserFileManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_TRASH } diff --git a/api/@ohos.fileshare.d.ts b/api/@ohos.fileshare.d.ts index 728df25c8e5a587c4ba11f87aabad8ae05d39657..fd9efdd225aa2252a2ef3996686c6e54fb39add6 100644 --- a/api/@ohos.fileshare.d.ts +++ b/api/@ohos.fileshare.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2022-2024 Huawei Device Co., Ltd. + * Copyright (C) 2022-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 @@ -18,15 +18,21 @@ * @kit CoreFileKit */ +/*** if arkts 1.1 */ import type { AsyncCallback, Callback } from './@ohos.base'; import type wantConstant from './@ohos.ability.wantConstant'; - +/*** endif */ +/*** if arkts 1.2 */ +import { AsyncCallback, Callback } from './@ohos.base'; +import type wantConstant from './@ohos.app.ability.wantConstant'; +/*** endif */ /** * Provides fileshare APIS * * @namespace fileShare * @syscap SystemCapability.FileManagement.AppFileService - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace fileShare { /** @@ -34,14 +40,16 @@ declare namespace fileShare { * * @enum { number } OperationMode * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum OperationMode { /** * Indicates read permissions. * * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ READ_MODE = 0b1, @@ -49,7 +57,8 @@ declare namespace fileShare { * Indicates write permissions. * * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ WRITE_MODE = 0b10, } @@ -136,7 +145,8 @@ declare namespace fileShare { * * @interface PolicyInfo * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface PolicyInfo { /** @@ -144,7 +154,8 @@ declare namespace fileShare { * * @type { string } * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; @@ -153,7 +164,8 @@ declare namespace fileShare { * * @type { number } * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ operationMode: number; } @@ -225,7 +237,8 @@ declare namespace fileShare { * @throws { BusinessError } 143000001 - IPC error * @syscap SystemCapability.FileManagement.AppFileService * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function grantUriPermission( uri: string, @@ -249,7 +262,8 @@ declare namespace fileShare { * @throws { BusinessError } 143000001 - IPC error * @syscap SystemCapability.FileManagement.AppFileService * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function grantUriPermission(uri: string, bundleName: string, flag: wantConstant.Flags): Promise; @@ -300,7 +314,8 @@ declare namespace fileShare { * @throws { BusinessError } 13900001 - Operation not permitted. * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function activatePermission(policies: Array): Promise; @@ -317,7 +332,8 @@ declare namespace fileShare { * @throws { BusinessError } 13900001 - Operation not permitted. * @throws { BusinessError } 13900042 - Unknown error * @syscap SystemCapability.FileManagement.AppFileService.FolderAuthorization - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function deactivatePermission(policies: Array): Promise; diff --git a/api/@ohos.font.d.ts b/api/@ohos.font.d.ts index 4a8422fd69866d2cda2a8c382a37841b5c387f0c..3bddff9027228945f0b911560d625daecb14133c 100644 --- a/api/@ohos.font.d.ts +++ b/api/@ohos.font.d.ts @@ -17,6 +17,9 @@ * @file * @kit ArkUI */ +/*** if arkts 1.2 */ +import { Resource } from './global/resource' +/*** endif */ /** * @namespace font @@ -34,7 +37,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace font { /** @@ -53,7 +57,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FontOptions { @@ -86,7 +91,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ familyName: string | Resource; @@ -119,7 +125,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ familySrc: string | Resource; } @@ -140,7 +147,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FontInfo { @@ -166,7 +174,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ path: string; @@ -192,7 +201,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ postScriptName: string; @@ -218,7 +228,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fullName: string; @@ -244,7 +255,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ family: string; @@ -270,7 +282,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ subfamily: string; @@ -296,7 +309,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ weight: number; @@ -322,7 +336,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -348,7 +363,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ italic: boolean; @@ -374,7 +390,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ monoSpace: boolean; @@ -400,7 +417,8 @@ declare namespace font { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ symbolic: boolean; } @@ -414,7 +432,8 @@ declare namespace font { * @typedef UIFontConfig * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIFontConfig { /** @@ -428,7 +447,8 @@ declare namespace font { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontDir: Array; @@ -443,7 +463,8 @@ declare namespace font { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ generic: Array; @@ -458,7 +479,8 @@ declare namespace font { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fallbackGroups: Array; } @@ -472,7 +494,8 @@ declare namespace font { * @typedef UIFontGenericInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIFontGenericInfo { /** @@ -486,7 +509,8 @@ declare namespace font { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ family: string; @@ -501,7 +525,8 @@ declare namespace font { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alias: Array; @@ -516,7 +541,8 @@ declare namespace font { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ adjust: Array; } @@ -530,7 +556,8 @@ declare namespace font { * @typedef UIFontAliasInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIFontAliasInfo { /** @@ -544,7 +571,8 @@ declare namespace font { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -561,7 +589,8 @@ declare namespace font { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ weight: number; } @@ -575,7 +604,8 @@ declare namespace font { * @typedef UIFontAdjustInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIFontAdjustInfo { /** @@ -589,7 +619,8 @@ declare namespace font { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ weight: number; /** @@ -603,7 +634,8 @@ declare namespace font { * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ to: number; } @@ -617,7 +649,8 @@ declare namespace font { * @typedef UIFontFallbackGroupInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIFontFallbackGroupInfo { /** @@ -633,7 +666,8 @@ declare namespace font { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSetName: string; @@ -648,7 +682,8 @@ declare namespace font { * @type { Array } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fallback: Array; } @@ -662,7 +697,8 @@ declare namespace font { * @typedef UIFontFallbackInfo * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface UIFontFallbackInfo { /** @@ -676,7 +712,8 @@ declare namespace font { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ language: string; @@ -691,7 +728,8 @@ declare namespace font { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ family: string; } @@ -796,7 +834,8 @@ declare namespace font { * @returns { UIFontConfig } Returns the ui font config * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getUIFontConfig(): UIFontConfig; } diff --git a/api/@ohos.geoLocationManager.d.ts b/api/@ohos.geoLocationManager.d.ts index ea7b62120f16cea356bd6a46d5d3cd01839b4038..1ffde8333aae07cf69754e8090ed2c105a23ee4f 100644 --- a/api/@ohos.geoLocationManager.d.ts +++ b/api/@ohos.geoLocationManager.d.ts @@ -18,8 +18,16 @@ * @kit LocationKit */ +/*** if arkts 1.1 */ +import { int, double } from './@ohos.base'; +/*** endif */ import { AsyncCallback, Callback } from './@ohos.base'; -import { WantAgent } from './@ohos.wantAgent'; +/*** if arkts 1.1 */ +import { WantAgent } from '@ohos.wantAgent'; +/*** endif */ +/*** if arkts 1.2 */ +import { WantAgent } from '@ohos.app.ability.wantAgent'; +/*** endif */ import { NotificationRequest } from './notification/notificationRequest'; /** @@ -36,7 +44,8 @@ import { NotificationRequest } from './notification/notificationRequest'; * @namespace geoLocationManager * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace geoLocationManager { /** @@ -546,7 +555,8 @@ declare namespace geoLocationManager { * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentLocation(request: CurrentLocationRequest | SingleLocationRequest, callback: AsyncCallback): void; @@ -578,7 +588,8 @@ declare namespace geoLocationManager { * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentLocation(callback: AsyncCallback): void; @@ -627,7 +638,8 @@ declare namespace geoLocationManager { * @throws { BusinessError } 3301200 - Failed to obtain the geographical location. * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentLocation(request?: CurrentLocationRequest | SingleLocationRequest): Promise; @@ -1591,7 +1603,8 @@ declare namespace geoLocationManager { * * @typedef ReverseGeoCodeRequest * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ReverseGeoCodeRequest { /** @@ -1599,7 +1612,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -1608,7 +1622,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ country?: string; @@ -1617,7 +1632,8 @@ declare namespace geoLocationManager { * * @type { number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ latitude: number; @@ -1626,7 +1642,8 @@ declare namespace geoLocationManager { * * @type { number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ longitude: number; @@ -1635,7 +1652,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ maxItems?: number; } @@ -1645,7 +1663,8 @@ declare namespace geoLocationManager { * * @typedef GeoCodeRequest * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export interface GeoCodeRequest { /** @@ -1653,7 +1672,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -1662,7 +1682,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ country?: string; @@ -1671,7 +1692,8 @@ declare namespace geoLocationManager { * * @type { string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ description: string; @@ -1680,7 +1702,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ maxItems?: number; @@ -1689,7 +1712,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ minLatitude?: number; @@ -1698,7 +1722,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ minLongitude?: number; @@ -1707,7 +1732,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ maxLatitude?: number; @@ -1716,7 +1742,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ maxLongitude?: number; } @@ -1726,7 +1753,8 @@ declare namespace geoLocationManager { * * @typedef GeoAddress * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export interface GeoAddress { /** @@ -1736,7 +1764,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ latitude?: number; @@ -1747,7 +1776,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ longitude?: number; @@ -1757,7 +1787,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -1766,7 +1797,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ placeName?: string; @@ -1775,7 +1807,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ countryCode?: string; @@ -1784,7 +1817,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ countryName?: string; @@ -1793,7 +1827,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ administrativeArea?: string; @@ -1802,7 +1837,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ subAdministrativeArea?: string; @@ -1811,7 +1847,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ locality?: string; @@ -1820,7 +1857,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ subLocality?: string; @@ -1829,7 +1867,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ roadName?: string; @@ -1838,7 +1877,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ subRoadName?: string; @@ -1847,7 +1887,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ premises?: string; @@ -1856,7 +1897,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ postalCode?: string; @@ -1865,7 +1907,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ phoneNumber?: string; @@ -1874,7 +1917,8 @@ declare namespace geoLocationManager { * * @type { ?string } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ addressUrl?: string; @@ -1883,7 +1927,8 @@ declare namespace geoLocationManager { * * @type { ?Array } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ descriptions?: Array; @@ -1892,7 +1937,8 @@ declare namespace geoLocationManager { * * @type { ?number } * @syscap SystemCapability.Location.Location.Geocoder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ descriptionsSize?: number; @@ -1902,7 +1948,8 @@ declare namespace geoLocationManager { * @type { ?Boolean } * @syscap SystemCapability.Location.Location.Geocoder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ isFromMock?: Boolean; } @@ -1920,7 +1967,8 @@ declare namespace geoLocationManager { * @typedef LocationRequest * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface LocationRequest { /** @@ -1936,7 +1984,8 @@ declare namespace geoLocationManager { * @type { ?LocationRequestPriority } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ priority?: LocationRequestPriority; @@ -1953,7 +2002,8 @@ declare namespace geoLocationManager { * @type { ?LocationRequestScenario } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scenario?: LocationRequestScenario; @@ -1970,7 +2020,8 @@ declare namespace geoLocationManager { * @type { ?number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ timeInterval?: number; @@ -1987,7 +2038,8 @@ declare namespace geoLocationManager { * @type { ?number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ distanceInterval?: number; @@ -2004,7 +2056,8 @@ declare namespace geoLocationManager { * @type { ?number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ maxAccuracy?: number; } @@ -2022,9 +2075,10 @@ declare namespace geoLocationManager { * @typedef CurrentLocationRequest * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - export interface CurrentLocationRequest { + export interface CurrentLocationRequest { /** * Priority of the location request. * @@ -2038,7 +2092,8 @@ declare namespace geoLocationManager { * @type { ?LocationRequestPriority } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ priority?: LocationRequestPriority; @@ -2055,43 +2110,46 @@ declare namespace geoLocationManager { * @type { ?LocationRequestScenario } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scenario?: LocationRequestScenario; /** * Accuracy requirements for reporting locations. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Accuracy requirements for reporting locations. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - maxAccuracy?: number; + maxAccuracy?: double; /** * Timeout interval of a single location request. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Timeout interval of a single location request. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - timeoutMs?: number; + timeoutMs?: int; } /** @@ -2127,7 +2185,8 @@ declare namespace geoLocationManager { * @typedef ContinuousLocationRequest * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ContinuousLocationRequest { /** @@ -2136,7 +2195,8 @@ declare namespace geoLocationManager { * @type { number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interval: number; @@ -2146,7 +2206,8 @@ declare namespace geoLocationManager { * @type { UserActivityScenario | PowerConsumptionScenario } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ locationScenario: UserActivityScenario | PowerConsumptionScenario; @@ -2158,7 +2219,8 @@ declare namespace geoLocationManager { * @syscap SystemCapability.Location.Location.Core * @systemapi * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ sportsType?: SportsType; } @@ -2169,7 +2231,8 @@ declare namespace geoLocationManager { * @typedef SingleLocationRequest * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface SingleLocationRequest { /** @@ -2178,19 +2241,21 @@ declare namespace geoLocationManager { * @type { LocatingPriority } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ locatingPriority: LocatingPriority; /** * Timeout of a single location request, in milliseconds. * - * @type { number } + * @type { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - locatingTimeoutMs: number; + locatingTimeoutMs: int; } /** @@ -2206,7 +2271,8 @@ declare namespace geoLocationManager { * @typedef Location * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface Location { /** @@ -2214,7 +2280,7 @@ declare namespace geoLocationManager { * A positive value indicates north latitude, * and a negative value indicates south latitude. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -2223,19 +2289,20 @@ declare namespace geoLocationManager { * A positive value indicates north latitude, * and a negative value indicates south latitude. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - latitude: number; + latitude: double; /** * Indicates Longitude information. * A positive value indicates east longitude , * and a negative value indicates west longitude. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ @@ -2244,114 +2311,121 @@ declare namespace geoLocationManager { * A positive value indicates east longitude , * and a negative value indicates west longitude. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - longitude: number; + longitude: double; /** * Indicates location altitude, in meters. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates location altitude, in meters. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - altitude: number; + altitude: double; /** * Indicates location accuracy, in meters. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates location accuracy, in meters. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - accuracy: number; + accuracy: double; /** * Indicates speed, in m/s. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates speed, in m/s. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - speed: number; + speed: double; /** * Indicates location timestamp in the UTC format. * - * @type { number } + * @type { int } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates location timestamp in the UTC format. * - * @type { number } + * @type { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - timeStamp: number; + timeStamp: int; /** * Indicates direction information. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates direction information. * - * @type { number } + * @type { double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - direction: number; + direction: double; /** * Indicates location timestamp since boot. * - * @type { number } + * @type { int } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates location timestamp since boot. * - * @type { number } + * @type { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - timeSinceBoot: number; + timeSinceBoot: int; /** * Indicates additional information. @@ -2366,7 +2440,8 @@ declare namespace geoLocationManager { * @type { ?Array } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ additions?: Array; @@ -2376,26 +2451,28 @@ declare namespace geoLocationManager { * @type { ?Map } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ additionsMap?: Map; /** * Indicates the amount of additional descriptive information. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Indicates the amount of additional descriptive information. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - additionSize?: number; + additionSize?: int; /** * Indicates whether it is an mock location. @@ -2403,49 +2480,54 @@ declare namespace geoLocationManager { * @type { ?Boolean } * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ isFromMock?: Boolean; /** * Indicates vertical position accuracy in meters. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - altitudeAccuracy?: number; + altitudeAccuracy?: double; /** * Indicates speed accuracy in meter per seconds. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - speedAccuracy?: number; + speedAccuracy?: double; /** * Indicates direction accuracy in degrees. * - * @type { ?number } + * @type { ?double } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - directionAccuracy?: number; + directionAccuracy?: double; /** * Time uncertainty Of timeSinceBoot in nanosecond. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - uncertaintyOfTimeSinceBoot?: number; + uncertaintyOfTimeSinceBoot?: int; /** * Indicates the source of the location. @@ -2453,7 +2535,8 @@ declare namespace geoLocationManager { * @type { ?LocationSourceType } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sourceType?: LocationSourceType; } @@ -2463,7 +2546,8 @@ declare namespace geoLocationManager { * @typedef LocatingRequiredDataConfig * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface LocatingRequiredDataConfig { /** @@ -2472,7 +2556,8 @@ declare namespace geoLocationManager { * @type {LocatingRequiredDataType} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type: LocatingRequiredDataType; @@ -2482,7 +2567,8 @@ declare namespace geoLocationManager { * @type {boolean} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ needStartScan: boolean; @@ -2493,7 +2579,8 @@ declare namespace geoLocationManager { * @type {?number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ scanInterval?: number; @@ -2504,7 +2591,8 @@ declare namespace geoLocationManager { * @type {?number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ scanTimeout?: number; } @@ -2514,7 +2602,8 @@ declare namespace geoLocationManager { * @typedef LocatingRequiredData * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface LocatingRequiredData { /** @@ -2523,7 +2612,8 @@ declare namespace geoLocationManager { * @type {?WifiScanInfo} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ wifiData?: WifiScanInfo; @@ -2533,7 +2623,8 @@ declare namespace geoLocationManager { * @type {?BluetoothScanInfo} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ bluetoothData?: BluetoothScanInfo; } @@ -2543,7 +2634,8 @@ declare namespace geoLocationManager { * @typedef WifiScanInfo * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface WifiScanInfo { /** @@ -2552,7 +2644,8 @@ declare namespace geoLocationManager { * @type {string} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ssid: string; @@ -2562,7 +2655,8 @@ declare namespace geoLocationManager { * @type {string} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ bssid: string; @@ -2572,7 +2666,8 @@ declare namespace geoLocationManager { * @type {number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ rssi: number; @@ -2582,7 +2677,8 @@ declare namespace geoLocationManager { * @type {number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ frequency: number; @@ -2592,7 +2688,8 @@ declare namespace geoLocationManager { * @type {number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; } @@ -2603,7 +2700,8 @@ declare namespace geoLocationManager { * @typedef BluetoothScanInfo * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface BluetoothScanInfo { /** @@ -2612,7 +2710,8 @@ declare namespace geoLocationManager { * @type {string} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ deviceName: string; @@ -2622,7 +2721,8 @@ declare namespace geoLocationManager { * @type {string} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ macAddress: string; @@ -2632,7 +2732,8 @@ declare namespace geoLocationManager { * @type {number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ rssi: number; @@ -2642,7 +2743,8 @@ declare namespace geoLocationManager { * @type {number} * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; } @@ -2652,7 +2754,8 @@ declare namespace geoLocationManager { * * @typedef BluetoothScanResult * @syscap SystemCapability.Location.Location.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ export interface BluetoothScanResult { /** @@ -2660,7 +2763,8 @@ declare namespace geoLocationManager { * * @type { string } * @syscap SystemCapability.Location.Location.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; @@ -2669,7 +2773,8 @@ declare namespace geoLocationManager { * * @type { number } * @syscap SystemCapability.Location.Location.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ rssi: number; @@ -2678,7 +2783,8 @@ declare namespace geoLocationManager { * * @type { ?ArrayBuffer } * @syscap SystemCapability.Location.Location.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ data?: ArrayBuffer; @@ -2687,7 +2793,8 @@ declare namespace geoLocationManager { * * @type { string } * @syscap SystemCapability.Location.Location.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ deviceName: string; @@ -2696,7 +2803,8 @@ declare namespace geoLocationManager { * * @type { boolean } * @syscap SystemCapability.Location.Location.Core - * @since 16 + * @since arkts {'1.1':'16','1.2':'20'} + * @arkts 1.1&1.2 */ connectable: boolean; } @@ -2704,10 +2812,11 @@ declare namespace geoLocationManager { /** * Enum for the source of the location. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocationSourceType { /** @@ -2715,7 +2824,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GNSS = 1, @@ -2724,7 +2834,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NETWORK = 2, @@ -2733,7 +2844,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INDOOR = 3, @@ -2742,7 +2854,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RTK = 4 } @@ -2752,14 +2865,16 @@ declare namespace geoLocationManager { * * @enum { number } * @syscap SystemCapability.Location.Location.Geofence - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum CoordinateSystemType { /** * WGS84 coordinates system. * * @syscap SystemCapability.Location.Location.Geofence - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WGS84 = 1, @@ -2767,7 +2882,8 @@ declare namespace geoLocationManager { * GCJ-02 coordinates system. * * @syscap SystemCapability.Location.Location.Geofence - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GCJ02 = 2 } @@ -2778,7 +2894,8 @@ declare namespace geoLocationManager { * @enum { number } * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocationIconStatus { /** @@ -2786,7 +2903,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_NOT_STARTED = 0, @@ -2795,7 +2913,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_STARTED = 1, @@ -2804,7 +2923,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HD_LOCATING_STARTED = 2 } @@ -2815,7 +2935,8 @@ declare namespace geoLocationManager { * @enum { number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocationError { /** @@ -2823,7 +2944,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_FAILED_DEFAULT = -1, @@ -2832,7 +2954,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_FAILED_LOCATION_PERMISSION_DENIED = -2, @@ -2841,7 +2964,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_FAILED_BACKGROUND_PERMISSION_DENIED = -3, @@ -2850,7 +2974,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_FAILED_LOCATION_SWITCH_OFF = -4, @@ -2859,7 +2984,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOCATING_FAILED_INTERNET_ACCESS_FAILURE = -5 } @@ -2902,14 +3028,16 @@ declare namespace geoLocationManager { * * @enum { number } * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum SatelliteConstellationCategory { /** * Invalid value. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_UNKNOWN = 0, @@ -2917,7 +3045,8 @@ declare namespace geoLocationManager { * GPS. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_GPS = 1, @@ -2925,7 +3054,8 @@ declare namespace geoLocationManager { * SBAS. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_SBAS = 2, @@ -2933,7 +3063,8 @@ declare namespace geoLocationManager { * GLONASS. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_GLONASS = 3, @@ -2941,7 +3072,8 @@ declare namespace geoLocationManager { * QZSS. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_QZSS = 4, @@ -2949,7 +3081,8 @@ declare namespace geoLocationManager { * BEIDOU. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_BEIDOU = 5, @@ -2957,7 +3090,8 @@ declare namespace geoLocationManager { * GALILEO. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_GALILEO = 6, @@ -2965,7 +3099,8 @@ declare namespace geoLocationManager { * IRNSS. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONSTELLATION_CATEGORY_IRNSS = 7 } @@ -2975,14 +3110,16 @@ declare namespace geoLocationManager { * * @enum { number } * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum SatelliteAdditionalInfo { /** * Default value. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATELLITES_ADDITIONAL_INFO_NULL = 0, @@ -2990,7 +3127,8 @@ declare namespace geoLocationManager { * Ephemeris data exist. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATELLITES_ADDITIONAL_INFO_EPHEMERIS_DATA_EXIST = 1, @@ -2998,7 +3136,8 @@ declare namespace geoLocationManager { * Almanac data exist. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATELLITES_ADDITIONAL_INFO_ALMANAC_DATA_EXIST = 2, @@ -3006,7 +3145,8 @@ declare namespace geoLocationManager { * This satellite is being used in location fix. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATELLITES_ADDITIONAL_INFO_USED_IN_FIX = 4, @@ -3014,7 +3154,8 @@ declare namespace geoLocationManager { * Carrier frequency exist. * * @syscap SystemCapability.Location.Location.Gnss - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATELLITES_ADDITIONAL_INFO_CARRIER_FREQUENCY_EXIST = 8 } @@ -3022,10 +3163,11 @@ declare namespace geoLocationManager { /** * Enum for user activity scenario. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum UserActivityScenario { /** @@ -3033,7 +3175,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION = 0x401, @@ -3042,7 +3185,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPORT = 0x402, @@ -3051,7 +3195,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TRANSPORT = 0x403, @@ -3060,7 +3205,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DAILY_LIFE_SERVICE = 0x404 } @@ -3068,10 +3214,11 @@ declare namespace geoLocationManager { /** * Enum for locating priority. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocatingPriority { /** @@ -3079,7 +3226,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIORITY_ACCURACY = 0x501, @@ -3088,7 +3236,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIORITY_LOCATING_SPEED = 0x502 } @@ -3096,17 +3245,18 @@ declare namespace geoLocationManager { /** * Enum for location priority. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Enum for location priority. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocationRequestPriority { /** @@ -3120,7 +3270,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UNSET = 0x200, @@ -3135,7 +3286,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ACCURACY, @@ -3150,7 +3302,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LOW_POWER, @@ -3165,7 +3318,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FIRST_FIX } @@ -3173,17 +3327,18 @@ declare namespace geoLocationManager { /** * Enum for location scenario. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @since 9 */ /** * Enum for location scenario. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocationRequestScenario { /** @@ -3197,7 +3352,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UNSET = 0x300, @@ -3212,7 +3368,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NAVIGATION, @@ -3227,7 +3384,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TRAJECTORY_TRACKING, @@ -3242,7 +3400,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CAR_HAILING, @@ -3257,7 +3416,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DAILY_LIFE_SERVICE, @@ -3272,7 +3432,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NO_POWER } @@ -3283,7 +3444,8 @@ declare namespace geoLocationManager { * @enum { number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum PowerConsumptionScenario { /** @@ -3291,7 +3453,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH_POWER_CONSUMPTION = 0x601, @@ -3300,7 +3463,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOW_POWER_CONSUMPTION = 0x602, @@ -3309,7 +3473,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NO_POWER_CONSUMPTION = 0x603 } @@ -3320,7 +3485,8 @@ declare namespace geoLocationManager { * @enum { number } * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocationPrivacyType { /** @@ -3328,7 +3494,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ OTHERS = 0, @@ -3337,7 +3504,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ STARTUP, @@ -3346,7 +3514,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ CORE_LOCATION } @@ -3357,7 +3526,8 @@ declare namespace geoLocationManager { * @enum { number } * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export enum SportsType { /** @@ -3365,7 +3535,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ RUNNING = 1, @@ -3374,7 +3545,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ WALKING, @@ -3383,7 +3555,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CYCLING } @@ -3420,7 +3593,8 @@ declare namespace geoLocationManager { * * @typedef CountryCode * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export interface CountryCode { /** @@ -3428,7 +3602,8 @@ declare namespace geoLocationManager { * * @type { string } * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ country: string; @@ -3437,7 +3612,8 @@ declare namespace geoLocationManager { * * @type { CountryCodeType } * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ type: CountryCodeType; } @@ -3447,14 +3623,16 @@ declare namespace geoLocationManager { * * @enum { number } * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export enum CountryCodeType { /** * Country code obtained from the locale setting. * * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ COUNTRY_CODE_FROM_LOCALE = 1, @@ -3462,7 +3640,8 @@ declare namespace geoLocationManager { * Country code obtained from the SIM information. * * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ COUNTRY_CODE_FROM_SIM, @@ -3470,7 +3649,8 @@ declare namespace geoLocationManager { * Query the country code information from the reverse geocoding result. * * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ COUNTRY_CODE_FROM_LOCATION, @@ -3478,7 +3658,8 @@ declare namespace geoLocationManager { * Obtain the country code from the cell registration information. * * @syscap SystemCapability.Location.Location.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ COUNTRY_CODE_FROM_NETWORK } @@ -3489,7 +3670,8 @@ declare namespace geoLocationManager { * @enum { number } * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LocatingRequiredDataType { /** @@ -3497,7 +3679,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ WIFI = 1, @@ -3506,7 +3689,8 @@ declare namespace geoLocationManager { * * @syscap SystemCapability.Location.Location.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ BLUETOOTH } diff --git a/api/@ohos.graphics.colorSpaceManager.d.ts b/api/@ohos.graphics.colorSpaceManager.d.ts index d1830c876a23f52b5924a8659fe28c317e4ed2d1..dbb4be075fd8416f5649a6b730df09bd5b9dcd9a 100644 --- a/api/@ohos.graphics.colorSpaceManager.d.ts +++ b/api/@ohos.graphics.colorSpaceManager.d.ts @@ -16,6 +16,7 @@ /** * @file * @kit ArkGraphics2D + * @arkts 1.1&1.2 */ /** @@ -40,7 +41,7 @@ * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ declare namespace colorSpaceManager { /** @@ -62,7 +63,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ enum ColorSpace { /** @@ -81,7 +82,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ UNKNOWN = 0, @@ -101,7 +102,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ ADOBE_RGB_1998 = 1, @@ -121,7 +122,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DCI_P3 = 2, @@ -141,7 +142,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DISPLAY_P3 = 3, @@ -161,7 +162,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ SRGB = 4, @@ -178,7 +179,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT709 = 6, @@ -195,7 +196,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT601_EBU = 7, @@ -212,7 +213,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT601_SMPTE_C = 8, @@ -229,7 +230,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT2020_HLG = 9, @@ -246,7 +247,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT2020_PQ = 10, @@ -261,7 +262,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ P3_HLG = 11, @@ -276,7 +277,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ P3_PQ = 12, @@ -291,7 +292,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ ADOBE_RGB_1998_LIMIT = 13, @@ -306,7 +307,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DISPLAY_P3_LIMIT = 14, @@ -321,7 +322,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ SRGB_LIMIT = 15, @@ -336,7 +337,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT709_LIMIT = 16, @@ -351,7 +352,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT601_EBU_LIMIT = 17, @@ -366,7 +367,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT601_SMPTE_C_LIMIT = 18, @@ -381,7 +382,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT2020_HLG_LIMIT = 19, @@ -396,7 +397,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ BT2020_PQ_LIMIT = 20, @@ -411,7 +412,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ P3_HLG_LIMIT = 21, @@ -426,7 +427,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ P3_PQ_LIMIT = 22, @@ -441,7 +442,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ LINEAR_P3 = 23, @@ -456,7 +457,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ LINEAR_SRGB = 24, @@ -471,7 +472,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ LINEAR_BT709 = LINEAR_SRGB, @@ -486,7 +487,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ LINEAR_BT2020 = 25, @@ -501,7 +502,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DISPLAY_SRGB = SRGB, @@ -516,7 +517,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DISPLAY_P3_SRGB = DISPLAY_P3, @@ -531,7 +532,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DISPLAY_P3_HLG = P3_HLG, @@ -546,7 +547,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ DISPLAY_P3_PQ = P3_PQ, @@ -566,7 +567,7 @@ declare namespace colorSpaceManager { * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ CUSTOM = 5, } @@ -584,7 +585,7 @@ declare namespace colorSpaceManager { * @typedef ColorSpacePrimaries * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ interface ColorSpacePrimaries { /** @@ -598,7 +599,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ redX: number; @@ -613,7 +614,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ redY: number; @@ -628,7 +629,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ greenX: number; @@ -643,7 +644,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ greenY: number; @@ -658,7 +659,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ blueX: number; @@ -673,7 +674,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ blueY: number; @@ -688,7 +689,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ whitePointX: number; @@ -703,7 +704,7 @@ declare namespace colorSpaceManager { * @type { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ whitePointY: number; } @@ -719,7 +720,7 @@ declare namespace colorSpaceManager { * @interface ColorSpaceManager * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ interface ColorSpaceManager { /** @@ -735,7 +736,7 @@ declare namespace colorSpaceManager { * @throws { BusinessError } 18600001 - The parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ getColorSpaceName(): ColorSpace; @@ -752,7 +753,7 @@ declare namespace colorSpaceManager { * @throws { BusinessError } 18600001 - The parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ getWhitePoint(): Array; @@ -769,7 +770,7 @@ declare namespace colorSpaceManager { * @throws { BusinessError } 18600001 - The parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ getGamma(): number; } @@ -793,7 +794,7 @@ declare namespace colorSpaceManager { * @throws { BusinessError } 18600001 - The parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ function create(colorSpaceName: ColorSpace): ColorSpaceManager; @@ -818,7 +819,7 @@ declare namespace colorSpaceManager { * @throws { BusinessError } 18600001 - The parameter value is abnormal. * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} */ function create(primaries: ColorSpacePrimaries, gamma: number): ColorSpaceManager; } diff --git a/api/@ohos.graphics.common2D.d.ets b/api/@ohos.graphics.common2D.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..eb61337df82a08d427c0825769bb87c679c04eb1 --- /dev/null +++ b/api/@ohos.graphics.common2D.d.ets @@ -0,0 +1,145 @@ +/* + * 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. + */ + +/** + * @file + * @kit ArkGraphics2D + */ +/** + * The date structure that provides the basis for graphics. + * + * @namespace common2D + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ +declare namespace common2D { + /** + * Provide a description in the form of color ARGB. + * @typedef Color + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export interface Color { + /** + * Alpha component of color, from 0 to 255. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + alpha: number; + /** + * Red component of color, from 0 to 255. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + red: number; + /** + * Green component of color, from 0 to 255. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + green: number; + /** + * Blue component of color, from 0 to 255. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + blue: number; + } + + /** + * Provides the definition of the rectangle. + * @typedef Rect + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export interface Rect { + /** + * Left Position of Rectangle. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + left: number; + /** + * Top side position of the rectangle + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + top: number; + /** + * Right Position of Rectangle. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + right: number; + /** + * Position of the bottom side of the rectangle. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + bottom: number; + } + + /** + * Coordinates in the font layout. + * @typedef Point + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export interface Point { + /** + * X-axis coordinate. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + x: number; + + /** + * Y-axis coordinate. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + y: number; + } + + /** + * Provides the definition of the point in 3D. + * + * @typedef Point3d + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export interface Point3d extends Point { + /** + * Z-axis coordinate. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + z: number; + } + +} + +export default common2D; \ No newline at end of file diff --git a/api/@ohos.graphics.displaySync.d.ts b/api/@ohos.graphics.displaySync.d.ts index 64492f0336280453755cfa140c410a7d45eb7a0f..89d3840ebe7e205214e6404ef445fd89aee60554 100644 --- a/api/@ohos.graphics.displaySync.d.ts +++ b/api/@ohos.graphics.displaySync.d.ts @@ -16,30 +16,34 @@ /** * @file * @kit ArkGraphics2D + * @arkts 1.1&1.2 */ import type { Callback } from './@ohos.base'; +/*** if arkts 1.2 */ +import { ExpectedFrameRateRange } from './arkui/component/common'; +/*** endif */ /** * Provides functions of applying an independent draw frame rate used for drawing the UI. * * @namespace displaySync * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ declare namespace displaySync { /** * Provides the IntervalInfo interface, which includes timestamp and targetTimestamp. * @interface IntervalInfo * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ interface IntervalInfo { /** * The timestamp means the current drawing frame time. * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ timestamp: number; @@ -47,7 +51,7 @@ declare namespace displaySync { * The timestamp means the next drawing frame time. * @type { number } * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ targetTimestamp: number; } @@ -57,7 +61,7 @@ declare namespace displaySync { * the frequency of triggering callback function. * @interface DisplaySync * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ interface DisplaySync { /** @@ -71,7 +75,7 @@ declare namespace displaySync { *
3. Parameter verification failed. * or check ExpectedFrameRateRange if valid. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ setExpectedFrameRateRange(rateRange: ExpectedFrameRateRange) : void; @@ -81,7 +85,7 @@ declare namespace displaySync { * @param { 'frame' } type - The type of event to remove the listener for. Must be 'frame'. * @param { Callback } callback - The callback function to be called when DisplaySync dispatching. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ on(type: 'frame', callback: Callback): void; @@ -92,7 +96,7 @@ declare namespace displaySync { * @param { Callback } [callback] - The callback function to remove. If not provided, all callbacks for the given event type * will be removed. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ off(type: 'frame', callback?: Callback): void; @@ -100,7 +104,7 @@ declare namespace displaySync { * Add DisplaySync to Pipeline. It means that * the callback function be enabled. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ start(): void; @@ -108,7 +112,7 @@ declare namespace displaySync { * Delete DisplaySync from Pipeline. It means that * the callback function be disabled. * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ stop(): void; } @@ -117,7 +121,7 @@ declare namespace displaySync { * Create a new DisplaySync object. * @returns { DisplaySync } DisplaySync * @syscap SystemCapability.ArkUI.ArkUI.Full - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} */ function create(): DisplaySync; } diff --git a/api/@ohos.graphics.drawing.d.ets b/api/@ohos.graphics.drawing.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..4e139eb54b2f6f684d8cfc04b8a4ed720744a215 --- /dev/null +++ b/api/@ohos.graphics.drawing.d.ets @@ -0,0 +1,3708 @@ +/* + * Copyright (c) 2023-2024 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 ArkGraphics2D + */ + +import type image from './@ohos.multimedia.image'; +import type common2D from './@ohos.graphics.common2D'; + +/** + * Provides functions such as 2D graphics rendering, text drawing, and image display. + * + * @namespace drawing + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ +declare namespace drawing { + /** + * Enumerate blending modes for colors. + * Blend is a operation that use 4 components(red, green, blue, alpha) to generate + * a new color from two colors(source, destination). + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export enum BlendMode { + /** + * Disable 4 regions(red, green, blue, alpha) + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + CLEAR = 0, + /** + * Use components of the source + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SRC = 1, + /** + * Use components of the destination + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DST = 2, + /** + * The source is placed above the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SRC_OVER = 3, + /** + * The Destination is placed above the source. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DST_OVER = 4, + /** + * Use source replaces the destination, and will not exceed the boundaries of the destination + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SRC_IN = 5, + /** + * Use destination, and will not exceed the boundaries of the source + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DST_IN = 6, + /** + * Source is use in outside of the boundaries of the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SRC_OUT = 7, + /** + * Destination is use in outside of the boundaries of the source. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DST_OUT = 8, + /** + * Source which overlaps the destination will replaces the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SRC_ATOP = 9, + /** + * Destination which overlaps the source will replaces the source. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DST_ATOP = 10, + /** + * Combine regions where source and destination do not overlap. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + XOR = 11, + /** + * The sum of the source and destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + PLUS = 12, + /** + * All components are multiplied. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + MODULATE = 13, + /** + * Multiply the complement values of the background and source color values, + * and then complement the result. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SCREEN = 14, + /** + * Multiplies or screens the colors, depending on destination + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + OVERLAY = 15, + /** + * Choose a darker background and source color. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DARKEN = 16, + /** + * Choose a lighter background and source color. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + LIGHTEN = 17, + /** + * Brightens destination color to reflect the source color. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + COLOR_DODGE = 18, + /** + * Darkens destination color to reflect the source color. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + COLOR_BURN = 19, + /** + * Multiplies or screens the colors, depending on source + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + HARD_LIGHT = 20, + /** + * Lightens or Darkens the colors, depending on the source. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SOFT_LIGHT = 21, + /** + * Subtract the darker of the two colors from the brighter color. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + DIFFERENCE = 22, + /** + * Produces an effect similar to difference mode, but with lower contrast. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + EXCLUSION = 23, + /** + * Multiply the source color by the destination color and replace the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + MULTIPLY = 24, + /** + * Use the hue of the source and the saturation and brightness of the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + HUE = 25, + /** + * Use the saturation of the source and the hue and brightness of the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + SATURATION = 26, + /** + * Use the hue and saturation of the source and the brightness of the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + COLOR = 27, + /** + * Use the brightness of the source and the hue and saturation of the destination. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + LUMINOSITY = 28, + } + + /** + * Enumerates direction for adding closed contours. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum PathDirection { + /** + * Clockwise direction for adding closed contours. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + CLOCKWISE = 0, + + /** + * Counter-clockwise direction for adding closed contours. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + COUNTER_CLOCKWISE = 1, + } + + /** + * Enumerates fill type of path. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum PathFillType { + /** + * Specifies that "inside" is computed by a non-zero sum of signed edge crossings. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + WINDING = 0, + + /** + * Specifies that "inside" is computed by an odd number of edge crossings. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + EVEN_ODD = 1, + + /** + * Same as winding, but draws outside of the path, rather than inside. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + INVERSE_WINDING = 2, + + /** + * Same as evenOdd, but draws outside of the path, rather than inside. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + INVERSE_EVEN_ODD = 3, + } + + /** + * Enumerate path measure flags for matrix. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum PathMeasureMatrixFlags { + /** + * Gets position. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + GET_POSITION_MATRIX = 0, + /** + * Gets tangent. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + GET_TANGENT_MATRIX = 1, + /** + * Gets both position and tangent. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + GET_POSITION_AND_TANGENT_MATRIX = 2, + } + + /** + * Provides the definition of the roundRect. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class RoundRect { + /** + * Creates a simple round rect with the same four corner radii. + * @param { common2D.Rect } rect - Indicates the Rect object. + * @param { number } xRadii - Indicates the corner radii on x-axis. + * @param { number } yRadii - Indicates the corner radii on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(rect: common2D.Rect, xRadii: number, yRadii: number); + + /** + * Sets the radiusX and radiusY for a specific corner position. + * @param { CornerPos } pos - Indicates the corner radius position. + * @param { number } x - Indicates the corner radius on x-axis. + * @param { number } y - Indicates the corner radius on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setCorner(pos: CornerPos, x: number, y: number): void; + + /** + * Gets a point with the values of x-axis and y-axis of the selected corner radius. + * @param { CornerPos } pos - Indicates the corner radius position. + * @returns { common2D.Point } Returns a point with the values of x-axis and y-axis of the corner radius. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getCorner(pos: CornerPos): common2D.Point; + + /** + * Translates round rect by (dx, dy). + * @param { number } dx - Indicates the offsets added to rect left and rect right. + * @param { number } dy - Indicates the offsets added to rect top and rect bottom. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + offset(dx: number, dy: number): void; + } + + /** + * Enumerates of operations when two paths are combined. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum PathOp { + /** + * Difference operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + DIFFERENCE = 0, + + /** + * Intersect operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + INTERSECT = 1, + + /** + * Union operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + UNION = 2, + + /** + * Xor operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + XOR = 3, + + /** + * Reverse difference operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + REVERSE_DIFFERENCE = 4, + } + + /** + * Describes a path object. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class Path { + /** + * Creates a Path. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(); + + /** + * Creates a Path from other path. + * @param { Path } path - the path to copy content from. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(path: Path); + + /** + * Sets the start point of a path + * @param { number } x - Indicates the x coordinate of the start point. + * @param { number } y - Indicates the y coordinate of the start point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + moveTo(x: number, y: number): void; + + /** + * Draws a line segment from the last point of a path to the target point. + * @param { number } x - Indicates the x coordinate of the target point. + * @param { number } y - Indicates the y coordinate of the target point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + lineTo(x: number, y: number): void; + + /** + * This is done by using angle arc mode. In this mode, a rectangle that encloses an ellipse is specified first, + * and then a start angle and a sweep angle are specified. + * The arc is a portion of the ellipse defined by the start angle and the sweep angle. + * By default, a line segment from the last point of the path to the start point of the arc is also added. + * @param { number } x1 - Indicates the x coordinate of the upper left corner of the rectangle. + * @param { number } y1 - Indicates the y coordinate of the upper left corner of the rectangle. + * @param { number } x2 - Indicates the x coordinate of the lower right corner of the rectangle. + * @param { number } y2 - Indicates the y coordinate of the lower right corner of the rectangle. + * @param { number } startDeg - Indicates the start angle, in degrees. + * @param { number } sweepDeg - Indicates the angle to sweep, in degrees. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + arcTo(x1: number, y1: number, x2: number, y2: number, startDeg: number, sweepDeg: number): void; + + /** + * Draws a quadratic Bezier curve from the last point of a path to the target point. + * @param { number } ctrlX - Indicates the x coordinate of the control point. + * @param { number } ctrlY - Indicates the y coordinate of the control point. + * @param { number } endX - Indicates the x coordinate of the target point. + * @param { number } endY - Indicates the y coordinate of the target point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + quadTo(ctrlX: number, ctrlY: number, endX: number, endY: number): void; + + /** + * Draws a conic from the last point of a path to the target point. + * @param { number } ctrlX - Indicates the x coordinate of the control point. + * @param { number } ctrlY - Indicates the y coordinate of the control point. + * @param { number } endX - Indicates the x coordinate of the target point. + * @param { number } endY - Indicates the y coordinate of the target point. + * @param { number } weight - Indicates the weight of added conic. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + conicTo(ctrlX: number, ctrlY: number, endX: number, endY: number, weight: number): void; + + /** + * Draws a cubic Bezier curve from the last point of a path to the target point. + * @param { number } ctrlX1 - Indicates the x coordinate of the first control point. + * @param { number } ctrlY1 - Indicates the y coordinate of the first control point. + * @param { number } ctrlX2 - Indicates the x coordinate of the second control point. + * @param { number } ctrlY2 - Indicates the y coordinate of the second control point. + * @param { number } endX - Indicates the x coordinate of the target point. + * @param { number } endY - Indicates the y coordinate of the target point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + cubicTo(ctrlX1: number, ctrlY1: number, ctrlX2: number, ctrlY2: number, endX: number, endY: number): void; + + /** + * Sets the relative starting point of a path. + * @param { number } dx - Indicates the x coordinate of the relative starting point. + * @param { number } dy - Indicates the y coordinate of the relative starting point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + rMoveTo(dx: number, dy: number): void; + + /** + * Draws a line segment from the last point of a path to the relative target point. + * @param { number } dx - Indicates the x coordinate of the relative target point. + * @param { number } dy - Indicates the y coordinate of the relative target point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + rLineTo(dx: number, dy: number): void; + + /** + * Draws a quadratic bezier curve from the last point of a path to the relative target point. + * @param { number } dx1 - Indicates the x coordinate of the relative control point. + * @param { number } dy1 - Indicates the y coordinate of the relative control point. + * @param { number } dx2 - Indicates the x coordinate of the relative target point. + * @param { number } dy2 - Indicates the y coordinate of the relative target point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + rQuadTo(dx1: number, dy1: number, dx2: number, dy2: number): void; + + /** + * Draws a conic from the last point of a path to the relative target point. + * @param { number } ctrlX - Indicates the x coordinate of the relative control point. + * @param { number } ctrlY - Indicates the y coordinate of the relative control point. + * @param { number } endX - Indicates the x coordinate of the relative target point. + * @param { number } endY - Indicates the y coordinate of the relative target point. + * @param { number } weight - Indicates the weight of added conic. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + rConicTo(ctrlX: number, ctrlY: number, endX: number, endY: number, weight: number): void; + + /** + * Draws a cubic bezier curve from the last point of a path to the relative target point. + * @param { number } ctrlX1 - Indicates the x coordinate of the first relative control point. + * @param { number } ctrlY1 - Indicates the y coordinate of the first relative control point. + * @param { number } ctrlX2 - Indicates the x coordinate of the second relative control point. + * @param { number } ctrlY2 - Indicates the y coordinate of the second relative control point. + * @param { number } endX - Indicates the x coordinate of the relative target point. + * @param { number } endY - Indicates the y coordinate of the relative target point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + rCubicTo(ctrlX1: number, ctrlY1: number, ctrlX2: number, ctrlY2: number, endX: number, endY: number): void; + + /** + * Adds contour created from point array, adding (count - 1) line segments. + * @param { Array } points - Indicates the point array. + * @param { boolean } close - Indicates Whether to add lines that connect the end and start. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addPolygon(points: Array, close: boolean): void; + + /** + * Combines two paths. + * @param { Path } path - Indicates the Path object. + * @param { PathOp } pathOp - Indicates the operator to apply path. + * @returns { boolean } boolean - Returns true if constructed path is not empty; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + op(path: Path, pathOp: PathOp): boolean; + + /** + * Appends arc to path, as the start of new contour. + * Arc added is part of ellipse bounded by oval, from startAngle through sweepAngle. + * @param { common2D.Rect } rect - The bounds of the arc is described by a rect. + * @param { number } startAngle - Indicates the starting angle of arc in degrees. + * @param { number } sweepAngle - Indicates the sweep, in degrees. Positive is clockwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addArc(rect: common2D.Rect, startAngle: number, sweepAngle: number): void; + + /** + * Adds a circle to the path, and wound in the specified direction. + * @param { number } x - Indicates the x coordinate of the center of the circle. + * @param { number } y - Indicates the y coordinate of the center of the circle. + * @param { number } radius - Indicates the radius of the circle. + * @param { PathDirection } pathDirection - The default value is CLOCKWISE. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addCircle(x: number, y: number, radius: number, pathDirection?: PathDirection): void; + + /** + * Adds a oval to the path, defined by the rect, and wound in the specified direction. + * @param { common2D.Rect } rect - The bounds of the oval is described by a rect. + * @param { number } start - Indicates the index of initial point of ellipse. + * @param { PathDirection } pathDirection - The default value is CLOCKWISE. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addOval(rect: common2D.Rect, start: number, pathDirection?: PathDirection): void; + + /** + * Adds a new contour to the path, defined by the rect, and wound in the specified direction. + * @param { common2D.Rect } rect - Indicates the Rect object. + * @param { PathDirection } pathDirection - The default value is CLOCKWISE. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addRect(rect: common2D.Rect, pathDirection?: PathDirection): void; + + /** + * Adds a new contour to the path, defined by the round rect, and wound in the specified direction. + * @param { RoundRect } roundRect - Indicates the RoundRect object. + * @param { PathDirection } pathDirection - The default value is CLOCKWISE. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addRoundRect(roundRect: RoundRect, pathDirection?: PathDirection): void; + + /** + * Appends src path to path, transformed by matrix. + * @param { Path } path - Indicates the Path object. + * @param { Matrix | null } matrix - Indicates transform applied to path. The default value is null. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + addPath(path: Path, matrix?: Matrix | null): void; + + /** + * Path is replaced by transformed data. + * @param { Matrix } matrix - Indicates transform applied to path. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + transform(matrix: Matrix): void; + + /** + * Returns the status that point (x, y) is contained by path. + * @param { number } x - Indicates the x-axis value of containment test. + * @param { number } y - Indicates the y-axis value of containment test. + * @returns { boolean } Returns true if the point (x, y) is contained by path; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + contains(x: number, y: number): boolean; + + /** + * Sets fill type, the rule used to fill path. + * @param { PathFillType } pathFillType - Indicates the enum path fill type. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setFillType(pathFillType: PathFillType): void; + + /** + * Gets the smallest bounding box that contains the path. + * @returns { common2D.Rect } Rect object. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getBounds(): common2D.Rect; + + /** + * Closes a path. A line segment from the start point to the last point of the path is added. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + close(): void; + + /** + * Offsets point array by (dx, dy). Path is replaced by offset data. + * @param { number } dx - Indicates offset added to dst path x-axis coordinates. + * @param { number } dy - Indicates offset added to dst path y-axis coordinates. + * @returns { Path } Returns a new Path object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + offset(dx: number, dy: number): Path; + + /** + * Resets path data. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + reset(): void; + + /** + * Get path length. + * @param { boolean } forceClosed - Whether to close the Path. + * @returns { number } Return path length. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getLength(forceClosed: boolean): number; + + /** + * Gets the position and tangent of the distance from the starting position of the path. + * + * @param { boolean } forceClosed - Whether to close the path. + * @param { number } distance - The distance from the start of the path, should be greater than 0 + * and less than 'GetLength()'. + * @param { common2D.Point } position - Sets to the position of distance from the starting position of the path. + * @param { common2D.Point } tangent - Sets to the tangent of distance from the starting position of the path. + * @returns { boolean } - Returns true if succeeded, otherwise false. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getPositionAndTangent(forceClosed: boolean, distance: number, position: common2D.Point, + tangent: common2D.Point): boolean; + + /** + * Determines whether the current contour is closed. + * + * @returns { boolean } - Returns true if the current contour is closed, otherwise false. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isClosed(): boolean; + + /** + * Computes the corresponding matrix at the specified distance. + * + * @param { boolean } forceClosed - Whether to close the path. + * @param { number } distance - The distance from the start of the path. + * @param { Matrix } matrix - Indicates the pointer to an Matrix object. + * @param { PathMeasureMatrixFlags } flags - Indicates what should be returned in the matrix. + * @returns { boolean } - Returns false if there is no path, or a zero-length path was specified, + * in which case matrix is unchanged. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getMatrix(forceClosed: boolean, distance: number, matrix: Matrix, flags: PathMeasureMatrixFlags): boolean; + + /** + * Parses the SVG format string that describes the drawing path, and sets the path. + * + * @param { string } str - A string in SVG format that describes the drawing path. + * @returns { boolean } true if build succeeded, otherwise false. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + buildFromSvgString(str: string): boolean; + } + + /** + * Enumerates of scale to fit flags, selects if an array of points are drawn as discrete points, + * as lines, or as an open polygon. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum PointMode { + /** + * Draws each point separately. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + POINTS = 0, + + /** + * Draws each pair of points as a line segment. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + LINES = 1, + + /** + * Draws the array of points as a open polygon. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + POLYGON = 2, + } + + /** + * Enumerates storage filter mode. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum FilterMode { + /** + * Single sample point (nearest neighbor). + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FILTER_MODE_NEAREST = 0, + + /** + * Interpolate between 2x2 sample points (bilinear interpolation). + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FILTER_MODE_LINEAR = 1, + } + + /** + * Enumerates of shadow flags. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum ShadowFlag { + /** + * Use no shadow flags. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + NONE = 0, + + /** + * The occluding object is transparent. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + TRANSPARENT_OCCLUDER = 1, + + /** + * No need to analyze shadows. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + GEOMETRIC_ONLY = 2, + + /** + * Use all shadow flags. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + ALL = 3, + } + + /** + * Provides an interface to the drawing, and samplingOptions used when sampling from the image. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class SamplingOptions { + /** + * Constructor for the samplingOptions. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(); + /** + * Constructor for the samplingOptions with filter mode. + * @param { FilterMode } filterMode - Storage filter mode. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(filterMode: FilterMode); + } + + /** + * Provides an interface to the drawing, and how to clip and transform the drawing. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class Canvas { + /** + * Constructor for the Canvas. + * @param { image.PixelMap } pixelmap - PixelMap. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + constructor(pixelmap: image.PixelMap); + + /** + * If rectangle is stroked, use pen to stroke width describes the line thickness, + * else use brush to fill the rectangle. + * @param { common2D.Rect } rect - Rectangle to draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawRect(rect: common2D.Rect): void; + + /** + * If rectangle is stroked, use pen to stroke width describes the line thickness, + * else use brush to fill the rectangle. + * @param { number } left - Indicates the left position of the rectangle. + * @param { number } top - Indicates the top position of the rectangle. + * @param { number } right - Indicates the right position of the rectangle. + * @param { number } bottom - Indicates the bottom position of the rectangle. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawRect(left: number, top: number, right: number, bottom: number): void; + + /** + * Draws a RoundRect. + * @param { RoundRect } roundRect - Indicates the RectRound object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawRoundRect(roundRect: RoundRect): void; + + /** + * Draws a nested RoundRect. + * @param { RoundRect } outer - Indicates the outer RectRound object. + * @param { RoundRect } inner - Indicates the inner RectRound object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawNestedRoundRect(outer: RoundRect, inner: RoundRect): void; + + /** + * Fills clipped canvas area with brush. + * @param { Brush } brush - Indicates the Brush object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawBackground(brush: Brush): void; + + /** + * Draws an offset spot shadow and outlining ambient shadow for the given path with circular light. + * @param { Path } path - Indicates the Path object. + * @param { common2D.Point3d } planeParams - Represents z offset of the occluder from the canvas based on x and y. + * @param { common2D.Point3d } devLightPos - Represents the position of the light relative to the canvas. + * @param { number } lightRadius - The radius of the circular light. + * @param { common2D.Color } ambientColor - Ambient shadow's color. + * @param { common2D.Color } spotColor - Spot shadow's color. + * @param { ShadowFlag } flag - Indicates the flag to control opaque occluder, shadow, and light position. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawShadow(path: Path, planeParams: common2D.Point3d, devLightPos: common2D.Point3d, lightRadius: number, + ambientColor: common2D.Color, spotColor: common2D.Color, flag: ShadowFlag) : void; + + /** + * Draws an offset spot shadow and outlining ambient shadow for the given path with circular light. + * In this function, the input of the parameter 'ambientColor' and 'spotColor' should be number + * @param { Path } path - Indicates the Path object. + * @param { common2D.Point3d } planeParams - Represents z offset of the occluder from the canvas based on x and y. + * @param { common2D.Point3d } devLightPos - Represents the position of the light relative to the canvas. + * @param { number } lightRadius - The radius of the circular light. + * @param { number } ambientColor - Ambient shadow's color represented by ARGB color of hexadecimal format. + * @param { number } spotColor - Spot shadow's color represented by ARGB color of hexadecimal format. + * @param { ShadowFlag } flag - Indicates the flag to control opaque occluder, shadow, and light position. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + drawShadow(path: Path, planeParams: common2D.Point3d, devLightPos: common2D.Point3d, lightRadius: number, + ambientColor: number, spotColor: number, flag: ShadowFlag) : void; + + /** + * If radius is zero or less, nothing is drawn. If circle is stroked, use pen to + * stroke width describes the line thickness, else use brush to fill the circle. + * @param { number } x - X coordinate of the circle center. + * @param { number } y - Y coordinate of the circle center. + * @param { number } radius - The radius of the circle must be greater than 0. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawCircle(x: number, y: number, radius: number): void; + + /** + * Draw a pixelmap, with the upper left corner at (left, top). + * @param { image.PixelMap } pixelmap - PixelMap. + * @param { number } left - Left side of image. + * @param { number } top - Top side of image. + * @throws { BusinessError } 401 - Parameter error. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + /** + * Draw a pixelmap, with the upper left corner at (left, top). + * @param { image.PixelMap } pixelmap - PixelMap. + * @param { number } left - Left side of image. + * @param { number } top - Top side of image. + * @param { SamplingOptions } samplingOptions - SamplingOptions used to describe the sampling mode. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawImage(pixelmap: image.PixelMap, left: number, top: number, samplingOptions?: SamplingOptions): void; + + /** + * Draws the specified source image onto the canvas, + * scaled and translated to the destination rectangle. + * @param { image.PixelMap } pixelmap - The source image. + * @param { common2D.Rect } dstRect - The area of destination canvas. + * @param { SamplingOptions } samplingOptions - SamplingOptions used to describe the sampling mode. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawImageRect(pixelmap: image.PixelMap, dstRect: common2D.Rect, samplingOptions?: SamplingOptions): void; + + /** + * Draws the specified source rectangle of the image onto the canvas, + * scaled and translated to the destination rectangle. + * @param { image.PixelMap } pixelmap - The source image. + * @param { common2D.Rect } srcRect - The area of source image. + * @param { common2D.Rect } dstRect - The area of destination canvas. + * @param { SamplingOptions } samplingOptions - SamplingOptions used to describe the sampling mode. + * @param { SrcRectConstraint } constraint - Constraint type. The default value is STRICT. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawImageRectWithSrc(pixelmap: image.PixelMap, srcRect: common2D.Rect, dstRect: common2D.Rect, + samplingOptions?: SamplingOptions, constraint?: SrcRectConstraint): void; + + /** + * Fills clip with color color. Mode determines how ARGB is combined with destination. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. + * @param { BlendMode } blendMode - Used to combine source color and destination. The default value is SRC_OVER. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawColor(color: common2D.Color, blendMode?: BlendMode): void; + + /** + * Fills clip with the specified ARGB color of hexadecimal format. + * @param { number } color - Number must be ARGB color of hexadecimal format. + * @param { BlendMode } blendMode - Used to combine source color and destination. The default value is SRC_OVER. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + drawColor(color: number, blendMode?: BlendMode): void; + + /** + * Fills the clipped rectangle with the specified ARGB color. + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @param { number } red - Red channel of color. The range of red must be [0, 255]. + * @param { number } green - Green channel of color. The range of green must be [0, 255]. + * @param { number } blue - Blue channel of color. The range of blue must be [0, 255]. + * @param { BlendMode } blendMode - Used to combine source color and destination. The default value is SRC_OVER. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawColor(alpha: number, red: number, green: number, blue: number, blendMode?: BlendMode): void; + + /** + * Draws an oval. + * @param { common2D.Rect } oval - The bounds of the oval is described by a rect. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawOval(oval: common2D.Rect): void; + + /** + * Draws an arc. + * @param { common2D.Rect } arc - The bounds of the arc is described by a rect. + * @param { number } startAngle - Indicates the startAngle of the arc. + * @param { number } sweepAngle - Indicates the sweepAngle of the arc. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawArc(arc: common2D.Rect, startAngle: number, sweepAngle: number): void; + + /** + * Draw a point. + * @param { number } x - X coordinate position of the point. + * @param { number } y - Y coordinate position of the point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawPoint(x: number, y: number): void; + + /** + * Draws point array as separate point, line segment or open polygon according to given point mode. + * @param { Array } points - Points array. + * @param { PointMode } mode - Draws points enum method. The default value is POINTS. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawPoints(points: Array, mode?: PointMode): void; + + /** + * Draws a path. + * @param { Path } path - Path to draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawPath(path: Path): void; + + /** + * Draws line segment from startPt to endPt. + * @param { number } x0 - X coordinate of the start point of the line segment. + * @param { number } y0 - Y coordinate of the start point of the line segment. + * @param { number } x1 - X coordinate of the end point of the line segment. + * @param { number } y1 - Y coordinate of the end point of the line segment. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawLine(x0: number, y0: number, x1: number, y1: number): void; + + /** + * Draws a single character. + * @param { string } text - A string containing only a single character. + * @param { Font } font - Font object. + * @param { number } x - X coordinate of the single character start point. + * @param { number } y - Y coordinate of the single character start point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawSingleCharacter(text: string, font: Font, x: number, y: number): void; + + /** + * Draws a textBlob + * @param { TextBlob } blob - TextBlob to draw. + * @param { number } x - X coordinate of the text start point. + * @param { number } y - Y coordinate of the text start point. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + drawTextBlob(blob: TextBlob, x: number, y: number): void; + + /** + * Draws the pixelmap base on the mesh which is evenly distributed across the pixelmap. + * @param { image.PixelMap } pixelmap - The pixelmap to draw using the mesh. + * @param { number } meshWidth - The number of columns in the mesh. + * @param { number } meshHeight - The number of rows in the mesh. + * @param { Array } vertices - Array of vertices, specifying where the mesh should be drawn. + * @param { number } vertOffset - Number of vert elements to skip before drawing. + * @param { Array } colors - Array of colors, specifying a color at each vertex. + * @param { number } colorOffset - Number of color elements to skip before drawing. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawPixelMapMesh(pixelmap: image.PixelMap, meshWidth: number, meshHeight: number, + vertices: Array, vertOffset: number, colors: Array, colorOffset: number): void; + + /** + * Draws a region. + * @param { Region } region - Region object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + drawRegion(region: Region): void; + + /** + * Set pen to a canvas. + * @param { Pen } pen - object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + attachPen(pen: Pen): void; + + /** + * Set brush to a canvas. + * @param { Brush } brush - Object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + attachBrush(brush: Brush): void; + + /** + * Unset pen to a canvas. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + detachPen(): void; + + /** + * Unset brush to a canvas. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + detachBrush(): void; + + /** + * Saves the current canvas status (canvas matrix) to the top of the stack. + * @returns { number } Return the number of saved states. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + save(): number; + + /** + * Saves matrix and clip, and allocates a bitmap for subsequent drawing. + * Calling restore discards changes to matrix and clip, and draws the bitmap. + * @param { common2D.Rect | null} rect - Optional layer size. The default value is null. + * @param { Brush | null} brush - Optional brush effect used to draw the layer. The default value is null. + * @returns { number } Return the number of saved states before this call. + * @throws { BusinessError } 401 - Parameter error. Possible causes: Mandatory parameters are left unspecified. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + saveLayer(rect?: common2D.Rect | null, brush?: Brush | null): number; + + /** + * Clears a canvas by using a specified color. + * @param { common2D.Color } color - Indicates the color, which is a 32-bit (ARGB) variable. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + clear(color: common2D.Color): void; + + /** + * Clears a canvas by using a specified color represented by ARGB color of hexadecimal format. + * @param { number } color - Number must be ARGB color of hexadecimal format. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + clear(color: number): void; + + /** + * Restores the canvas status (canvas matrix) saved on the top of the stack. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + restore(): void; + + /** + * Restores the specific number of the canvas status (canvas matrix) saved in the stack. + * @param { number } count - Depth of state stack to restore. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + restoreToCount(count: number): void; + + /** + * Gets the number of the canvas status (canvas matrix) saved in the stack. + * @returns { number } Return represent depth of save state stack. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getSaveCount(): number; + + /** + * Gets the width of a canvas. + * @returns { number } Return the width of a canvas. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getWidth(): number; + + /** + * Gets the height of a canvas. + * @returns { number } Return the height of a canvas. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getHeight(): number; + + /** + * Gets the bounds of clip of a canvas. + * @returns { common2D.Rect } Rect object. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getLocalClipBounds(): common2D.Rect; + + /** + * Gets a 3x3 matrix of the transform from local coordinates to 'device'. + * @returns { Matrix } Matrix object. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getTotalMatrix(): Matrix; + + /** + * Scales by sx on the x-axis and sy on the y-axis. + * @param { number } sx - Indicates the amount to scale on x-axis. + * @param { number } sy - Indicates the amount to scale on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + scale(sx: number, sy: number): void; + + /** + * Skews by sx on the x-axis and sy on the y-axis. + * @param { number } sx - Indicates the value skew transformation on x-axis. + * @param { number } sy - Indicates the value skew transformation on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + skew(sx: number, sy: number) : void; + + /** + * Rotates by degrees, positive degrees rotates clockwise. + * @param { number } degrees - Indicates the amount to rotate, in degrees. + * @param { number } sx - Indicates the x-axis value of the point to rotate about. + * @param { number } sy - Indicates the y-axis value of the point to rotate about. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + rotate(degrees: number, sx: number, sy: number) : void; + + /** + * Translates by dx along the x-axis and dy along the y-axis. + * @param { number } dx - Indicates the distance to translate on x-axis. + * @param { number } dy - Indicates the distance to translate on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + translate(dx: number, dy: number): void; + + /** + * Replaces the clipping area with the intersection or difference of the current clipping area and path, + * and use a clipping edge that is aliased or anti-aliased. + * @param { Path } path - To combine with clip. + * @param { ClipOp } clipOp - Indicates the operation to apply to clip. The default value is intersect. + * @param { boolean } doAntiAlias - True if clip is to be anti-aliased. The default value is false. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + clipPath(path: Path, clipOp?: ClipOp, doAntiAlias?: boolean): void; + + /** + * Replaces the clipping area with the intersection or difference between the + * current clipping area and Rect, and use a clipping edge that is aliased or anti-aliased. + * @param { common2D.Rect } rect - To combine with clipping area. + * @param { ClipOp } clipOp - Indicates the operation to apply to clip. The default value is intersect. + * @param { boolean } doAntiAlias - True if clip is to be anti-aliased. The default value is false. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + clipRect(rect: common2D.Rect, clipOp?: ClipOp, doAntiAlias?: boolean): void; + + /** + * Uses the passed matrix to transforming the geometry, then use existing matrix. + * @param { Matrix } matrix - Declares functions related to the matrix object in the drawing module. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + concatMatrix(matrix: Matrix): void; + + /** + * Replace the clipping area with the intersection or difference of the + * current clipping area and Region, and use a clipping edge that is aliased or anti-aliased. + * @param { Region } region - Region object. + * @param { ClipOp } clipOp - Indicates the operation to apply to clip. The default value is intersect. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + clipRegion(region: Region, clipOp?: ClipOp): void; + + /** + * Replaces the clipping area with the intersection or difference between the + * current clipping area and RoundRect, and use a clipping edge that is aliased or anti-aliased. + * @param { RoundRect } roundRect - To combine with clipping area. + * @param { ClipOp } clipOp - Indicates the operation to apply to clip. The default value is intersect. + * @param { boolean } doAntiAlias - True if clip is to be anti-aliased. The default value is false. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + clipRoundRect(roundRect: RoundRect, clipOp?: ClipOp, doAntiAlias?: boolean): void; + + /** + * Checks whether the drawable area is empty. + * @returns { boolean } Returns true if drawable area is empty. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isClipEmpty(): boolean; + + /** + * Sets matrix of canvas. + * @param { Matrix } matrix - Declares functions related to the matrix object in the drawing module. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setMatrix(matrix: Matrix): void; + + /** + * Sets matrix of canvas to the identity matrix. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + resetMatrix(): void; + } + + /** + * Enumerates clip operations. + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum ClipOp { + /** + * Clips with difference. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + DIFFERENCE = 0, + /** + * Clips with intersection. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + INTERSECT = 1, + } + + /** + * Provide a description of the type and position of the text. + * @typedef TextBlobRunBuffer + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export interface TextBlobRunBuffer { + /** + * Text model. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + glyph: number; + /** + * X-coordinate of the text start point. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + positionX: number; + /** + * Y-coordinate of the text start point. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + positionY: number; + } + + /** + * Encoding type of the description text. + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export enum TextEncoding { + /** + * Use 1 byte to represent UTF-8 or ASCII + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + TEXT_ENCODING_UTF8 = 0, + /** + * Use 2 bytes to represent most of unicode + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + TEXT_ENCODING_UTF16 = 1, + /** + * Use 4 bytes to represent all unicode. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + TEXT_ENCODING_UTF32 = 2, + /** + * Use 2 bytes to represent the glyph index. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + TEXT_ENCODING_GLYPH_ID = 3, + } + + /** + * Provide a description of the text + * + * class TextBlob + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class TextBlob { + /** + * Create a textblob from a string + * @param { string } text - Drawn glyph content. + * @param { Font } font - Specify text size, font, text scale, etc. + * @param { TextEncoding } encoding - The default value is TEXT_ENCODING_UTF8. + * @returns { TextBlob } TextBlob object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static makeFromString(text: string, font: Font, encoding?: TextEncoding): TextBlob; + + /** + * Create a textblob from a string, each element of which is located at the given positions. + * @param { string } text - Drawn glyph content. + * @param { number } len - string length, value must equal to points length. + * @param { common2D.Point[] } points - Position coordinates of a textblob elements. + * @param { Font } font - Specify text size, font, text scale, etc. + * @returns { TextBlob } TextBlob object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static makeFromPosText(text: string, len: number, points: common2D.Point[], font: Font): TextBlob; + + /** + * Creating a textblob object based on RunBuffer information + * @param { Array } pos - The array of TextBlobRunBuffer. + * @param { Font } font - Font used for this run. + * @param { common2D.Rect } bounds - Optional run bounding box. The default value is null; + * @returns { TextBlob } TextBlob object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static makeFromRunBuffer(pos: Array, font: Font, bounds?: common2D.Rect): TextBlob; + + /** + * Returns the bounding rectangle shape + * @returns { common2D.Rect } Rect object. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + bounds(): common2D.Rect; + + /** + * Returns an unique identifier for a textblob. + * @returns { number } Unique ID. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + uniqueID(): number; + } + + /** + * The Typeface class specifies the typeface and intrinsic style of a font. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class Typeface { + /** + * Get the family name for this typeface. + * @returns { string } Family name. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + getFamilyName(): string; + + /** + * Generate typeface from file. + * @param { string } filePath - file path for typeface. + * @returns { Typeface } Typeface. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static makeFromFile(filePath: string): Typeface; + } + + /** + * Enumerates text edging types. + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum FontEdging { + /** + * Uses anti aliasing, default value. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + ALIAS = 0, + + /** + * Uses sub-pixel anti aliasing. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + ANTI_ALIAS = 1, + + /** + * Uses sub-pixel anti aliasing and enable sub-pixel localization. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + SUBPIXEL_ANTI_ALIAS = 2, + } + + /** + * Enumerates text hinting types. + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum FontHinting { + /** + * Not use text hinting. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + NONE = 0, + + /** + * Uses slight text hinting. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + SLIGHT = 1, + + /** + * Uses normal text hinting. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + NORMAL = 2, + + /** + * Uses full text hinting. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FULL = 3, + } + + /** + * Font controls options applied when drawing and measuring text. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class Font { + /** + * Requests, but does not require, that glyphs respect sub-pixel positioning. + * @param { boolean } isSubpixel - Setting for sub-pixel positioning. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + enableSubpixel(isSubpixel: boolean): void; + + /** + * Increases stroke width when creating glyph bitmaps to approximate a bold typeface. + * @param { boolean } isEmbolden - Setting for bold approximation. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + enableEmbolden(isEmbolden: boolean): void; + + /** + * Requests linearly scalable font and glyph metrics. + * @param { boolean } isLinearMetrics - Setting for linearly scalable font and glyph metrics. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + enableLinearMetrics(isLinearMetrics: boolean): void; + + /** + * Sets text size in points. Has no effect if textSize is not greater than or equal to zero. + * @param { number } textSize - Typographic height of text. The height of the text must be greater than 0. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setSize(textSize: number): void; + + /** + * Obtains the text size. + * @returns { number } Text size. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + getSize(): number; + + /** + * Sets Typeface to font. + * @param { Typeface } typeface - Font and style used to draw text. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setTypeface(typeface: Typeface): void; + + /** + * Get Typeface to font. + * @returns { Typeface } Typeface. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + getTypeface(): Typeface; + + /** + * Get fontMetrics associated with typeface. + * @returns { FontMetrics } The fontMetrics value returned to the caller. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + getMetrics(): FontMetrics; + + /** + * Measure a single character. + * @param { string } text - A string containing only a single character. + * @returns { number } The width of the single character. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + measureSingleCharacter(text: string): number; + /** + * Measure the width of text. + * @param { string } text - Text Symbol Content. + * @param { TextEncoding } encoding - Encoding format. + * @returns { number } The width of text. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + measureText(text: string, encoding: TextEncoding): number; + + /** + * Sets text scale on x-axis to font. + * @param { number } scaleX - Text scaleX. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setScaleX(scaleX: number): void; + + /** + * Sets text skew on x-axis to font. + * @param { number } skewX - Text skewX. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setSkewX(skewX: number): void; + + /** + * Sets the edging effect to font. + * @param { FontEdging } edging - Text edging. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setEdging(edging: FontEdging): void; + + /** + * Sets the hinting pattern to font. + * @param { FontHinting } hinting - Text hinting. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setHinting(hinting: FontHinting): void; + + /** + * Calculates number of glyphs represented by text. + * @param { string } text - Indicates the character storage encoded with text encoding. + * @returns { number } Returns the count of text. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + countText(text: string): number; + + /** + * Sets whether the font baselines and pixels alignment when the transformation matrix is ​​axis aligned. + * @param { boolean } isBaselineSnap - Indicates whether the font baselines and pixels alignment. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setBaselineSnap(isBaselineSnap: boolean): void; + + /** + * Gets whether the font baselines and pixels alignment when the transformation matrix is ​​axis aligned. + * @returns { boolean } Returns true if the font baselines and pixels alignment; returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isBaselineSnap(): boolean; + + /** + * Sets whether to use bitmaps instead of outlines in the object. + * @param { boolean } isEmbeddedBitmaps - Indicates whether to use bitmaps instead of outlines. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setEmbeddedBitmaps(isEmbeddedBitmaps: boolean): void; + + /** + * Gets whether to use bitmaps instead of outlines in the object. + * @returns { boolean } if using bitmaps instead of outlines; returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isEmbeddedBitmaps(): boolean; + + /** + * Sets whether the font outline is automatically adjusted. + * @param { boolean } isForceAutoHinting - Indicates whether the font outline is automatically adjusted. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setForceAutoHinting(isForceAutoHinting: boolean): void; + + /** + * Gets whether the font outline is automatically adjusted. + * @returns { boolean } Returns true if the font outline is automatically adjusted; returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isForceAutoHinting(): boolean; + + /** + * Retrieves the advance for each glyph in glyphs. + * @param { Array } glyphs - Array of glyph indices to be measured. + * @returns { Array } Returns the width of each character in a string. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getWidths(glyphs: Array): Array; + + /** + * Gets storage for glyph indexes. + * @param { string } text - Indicates the character storage encoded with text encoding. + * @param { number } glyphCount - The number of glyph. The default value is the result of calling countText. + * @returns { Array } Returns the storage for glyph indices. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + textToGlyphs(text: string, glyphCount?: number): Array; + + /** + * Returns true if glyphs may be drawn at sub-pixel offsets. + * @returns { boolean } True if glyphs may be drawn at sub-pixel offsets. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isSubpixel(): boolean; + /** + * Returns true if font and glyph metrics are requested to be linearly scalable. + * @returns { boolean } True if font and glyph metrics are requested to be linearly scalable. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isLinearMetrics(): boolean; + /** + * Returns text skew on x-axis. + * @returns { number } Additional shear on x-axis relative to y-axis. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getSkewX(): number; + /** + * Gets whether to increase the stroke width to approximate bold fonts. + * @returns { boolean } Returns true to increase the stroke width to approximate bold fonts; + * returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isEmbolden(): boolean; + /** + * Returns text scale on x-axis. + * @returns { number } Text horizontal scale. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getScaleX(): number; + /** + * Gets font hinting pattern. + * @returns { FontHinting } Font hinting level. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getHinting(): FontHinting; + /** + * Gets font edge pixels pattern. + * @returns { FontEdging } Edge pixels pattern. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getEdging(): FontEdging; + /** + * Create path object of specified Glyph. + * @param { number } index - the index of Glyphs. + * @returns { Path } The path object for specified glyph, undefined if not found. + * Note: Path use y-axis-goes-down system, y axis is inverted to the y-axis-goes-up system. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 14 + */ + createPathForGlyph(index: number): Path; + /** + * Retrieves the bounding rect for each glyph in glyphs. + * @param { Array } glyphs - Indicates the array of glyph indices to be measured. + * @returns { Array } Returns bounds for each glyph relative to (0, 0). + * Note: 1. Rect use y-axis-goes-down system, y axis is inverted to the y-axis-goes-up system. + *
2. Rect use two points(left-bottom & right-top) to describe the bound. + *
3. The bound rect will be snap to integral boundaries. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 14 + */ + getBounds(glyphs: Array): Array; + /** + * Get path of text. + * @param { string } text - Indicates the character storage encoded with text encoding. + * @param { number } byteLength - Indicates the byte length of the text. + * @param { number } x - Indicates X coordinate for the starting position of the text within the drawing area. + * @param { number } y - Indicates Y coordinate for the starting position of the text within the drawing area. + * @returns { Path } The path object for Glyph. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 14 + */ + getTextPath(text: string, byteLength: number, x: number, y: number): Path; + } + + /** + * Indicate when certain metrics are valid; the underline or strikeout metrics may be valid and zero. + * Fonts with embedded bitmaps may not have valid underline or strikeout metrics. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum FontMetricsFlags { + /** + * Set if underlineThickness of FontMetrics is valid. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + UNDERLINE_THICKNESS_VALID = 1 << 0, + + /** + * Set if underlinePosition of FontMetrics is valid. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + UNDERLINE_POSITION_VALID = 1 << 1, + + /** + * Set if strikethroughThickness of FontMetrics is valid. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + STRIKETHROUGH_THICKNESS_VALID = 1 << 2, + + /** + * Set if strikethroughPosition of FontMetrics is valid. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + STRIKETHROUGH_POSITION_VALID = 1 << 3, + + /** + * set if top, bottom, xMin, xMax of FontMetrics invalid. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + BOUNDS_INVALID = 1 << 4, + } + + /** + * The metrics of an Font. + * @typedef FontMetrics + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export interface FontMetrics { + /** + * Indicating which metrics are valid. + * @type { ?FontMetricsFlags } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + flags?: FontMetricsFlags; + + /** + * Maximum range above the glyph bounding box. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + top: number; + /** + * Distance Retained Above Baseline. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + ascent: number; + /** + * The distance that remains below the baseline. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + descent: number; + /** + * Maximum range below the glyph bounding box. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + bottom: number; + /** + * Line Spacing. + * @type { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + leading: number; + /** + * Average character width, zero if unknown. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + avgCharWidth?: number; + + /** + * Maximum character width, zero if unknown. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + maxCharWidth?: number; + + /** + * Greatest extent to left of origin of any glyph bounding box, typically negative; deprecated with variable fonts. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + xMin?: number; + + /** + * Greatest extent to right of origin of any glyph bounding box, typically positive; + * deprecated with variable fonts. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + xMax?: number; + + /** + * Height of lower-case 'x', zero if unknown, typically negative. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + xHeight?: number; + + /** + * Height of an upper-case letter, zero if unknown, typically negative. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + capHeight?: number; + + /** + * Underline thickness. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + underlineThickness?: number; + + /** + * Distance from baseline to top of stroke, typically positive. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + underlinePosition?: number; + + /** + * Strikethrough thickness. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + strikethroughThickness?: number; + + /** + * Distance from baseline to bottom of stroke, typically negative. + * @type { ?number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + strikethroughPosition?: number; + } + + /** + * Lattice is the class for dividing an image into grids. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class Lattice { + /** + * Divide an image into a rectangular grid. Grid entries on even columns and even rows are fixed; + * these entries are always drawn at their original size if the destination is large enough. If the destination + * side is too small to hold the fixed entries, all fixed entries are scaled down to fit. + * The grid entries not on even columns and rows are scaled to fit the remaining space, if any. + * @param { Array } xDivs - X coordinate of values used to divide the image. + * @param { Array } yDivs - Y coordinate of values used to divide the image. + * @param { number } fXCount - Number of x coordinates. Must be >= 0. + * @param { number } fYCount - Number of y coordinates. Must be >= 0. + * @param { common2D.Rect | null } fBounds - Source bounds to draw from. The default value is null. + * @param { Array | null } fRectTypes - Array of fill types. The default value is null. + * @param { Array | null } fColors - Array of colors. The default value is null. + * @returns { Lattice } Lattice object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createImageLattice(xDivs: Array, yDivs: Array, fXCount: number, fYCount: number, + fBounds?: common2D.Rect | null, fRectTypes?: Array | null, fColors?: Array | null): Lattice; + } + + /** + * Enumerate rect types. Optional setting per rectangular grid entry to make it transparent, + * or to fill the grid entry with a color. only used in Lattice. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum RectType { + /** + * Draws image into lattice rect. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + DEFAULT = 0, + + /** + * Skips lattice rect by making it transparent. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + TRANSPARENT = 1, + + /** + * Draws one of fColors into lattice rect. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FIXEDCOLOR = 2 + } + + /** + * MaskFilter is the class for object that perform transformations on an alpha-channel mask before drawing it. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class MaskFilter { + /** + * Makes a MaskFilter with a blur effect. + * @param { BlurType } blurType - Indicates the blur type. + * @param { number } sigma - Indicates the standard deviation of the Gaussian blur to apply. Must be > 0. + * @returns { MaskFilter } MaskFilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createBlurMaskFilter(blurType: BlurType, sigma: number): MaskFilter; + } + + /** + * Defines a PathEffect, which is used to affects stroked paths. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class PathEffect { + /** + * Makes a dash PathEffect. + * @param { Array } intervals - Array of ON and OFF distances. Must contain an even number of entries (>=2), + * with the even indices specifying the "on" intervals, and the odd indices specifying the "off" intervals. + * @param { number } phase - Offset into the intervals array. + * @returns { PathEffect } PathEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createDashPathEffect(intervals: Array, phase: number): PathEffect; + + /** + * Makes a corner PathEffect. + * @param { number } radius - Indicates the radius of the tangent circle at the corners of the path. + * The radius must be greater than 0. + * @returns { PathEffect } PathEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createCornerPathEffect(radius: number): PathEffect; + } + + /** + * Describes a shader effect object. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class ShaderEffect { + /** + * Creates an ShaderEffect object that generates a shader with single color. + * @param { number } color - Indicates the color used by the shader. + * @returns { ShaderEffect } Returns the shader with single color ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createColorShader(color: number): ShaderEffect; + + /** + * Creates an ShaderEffect object that generates a linear gradient between the two specified points. + * @param { common2D.Point } startPt - Indicates the start point for the gradient. + * @param { common2D.Point } endPt - Indicates the end point for the gradient. + * @param { Array } colors - Indicates the colors to be distributed between the two points. + * @param { TileMode } mode - Indicates the tile mode. + * @param { Array | null } pos - Indicates the relative position of each corresponding color + *
in the colors array. The default value is empty for uniform distribution. + * @param { Matrix | null } matrix - Indicates the Matrix object. The default value is null. + * @returns { ShaderEffect } Returns a linear gradient ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createLinearGradient(startPt: common2D.Point, endPt: common2D.Point, colors: Array, + mode: TileMode, pos?: Array | null, matrix?: Matrix | null): ShaderEffect; + + /** + * Creates an ShaderEffect object that generates a radial gradient given the center and radius. + * @param { common2D.Point } centerPt - Indicates the center of the circle for the gradient. + * @param { number } radius - Indicates the radius of the circle for this gradient. + * @param { Array } colors - Indicates the colors to be distributed between the two points. + * @param { TileMode } mode - Indicates the tile mode. + * @param { Array | null } pos - Indicates the relative position of each corresponding color + *
in the colors array. The default value is empty for uniform distribution. + * @param { Matrix | null } matrix - Indicates the Matrix object. The default value is null. + * @returns { ShaderEffect } Returns a radial gradient ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createRadialGradient(centerPt: common2D.Point, radius: number, colors: Array, + mode: TileMode, pos?: Array | null, matrix?: Matrix | null): ShaderEffect; + + /** + * Creates an ShaderEffect object that generates a sweep gradient given a center. + * @param { common2D.Point } centerPt - Indicates the center of the circle for the gradient. + * @param { Array } colors - Indicates the colors to be distributed between the two points. + * @param { TileMode } mode - Indicates the tile mode. + * @param { number } startAngle - The starting angle of the gradient. + * @param { number } endAngle - The ending angle of the gradient. + * @param { Array | null } pos - Indicates the relative position of each corresponding color + *
in the colors array. The default value is empty for uniform distribution. + * @param { Matrix | null } matrix - Indicates the Matrix object. The default value is null. + * @returns { ShaderEffect } Returns a sweep gradient ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createSweepGradient(centerPt: common2D.Point, colors: Array, + mode: TileMode, startAngle: number, endAngle: number, pos?: Array | null, + matrix?: Matrix | null): ShaderEffect; + + /** + * Creates an ShaderEffect object that generates a conical gradient given two circles. + * @param { common2D.Point } startPt - Indicates the center of the start circle for the gradient. + * @param { number } startRadius - Indicates the radius of the start circle for this gradient. + * @param { common2D.Point } endPt - Indicates the center of the end circle for the gradient. + * @param { number } endRadius - Indicates the radius of the end circle for this gradient. + * @param { Array } colors - Indicates the colors to be distributed between the two points. + * @param { TileMode } mode - Indicates the tile mode. + * @param { Array | null } pos - Indicates the relative position of each corresponding color + *
in the colors array. The default value is empty for uniform distribution. + * @param { Matrix | null } matrix - Indicates the Matrix object. The default value is null. + * @returns { ShaderEffect } Returns a conical gradient ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createConicalGradient(startPt: common2D.Point, startRadius: number, endPt: common2D.Point, + endRadius: number, colors: Array, mode: TileMode, + pos?: Array | null, matrix?: Matrix | null): ShaderEffect; + } + + /** + * Enumerates tile modes that describe an image or texture. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum TileMode { + /** + * Replicate the edge color if the shader effect draws outside of its original bounds. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + CLAMP = 0, + + /** + * Repeat the shader effect image horizontally and vertically. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + REPEAT = 1, + + /** + * Repeat the shader effect image horizontally and vertically, alternating mirror images + * so that adjacent images always seam. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + MIRROR = 2, + + /** + * Only draw within the original domain, return transparent-black everywhere else. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + DECAL = 3, + } + + /** + * Defines a ShadowLayer, which is used to specify the color, blur radius, and offset of the shadow. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class ShadowLayer { + /** + * Makes a new ShadowLayer. + * + * @param { number } blurRadius - The blur radius of the shadow. The blur radius must be greater than 0. + * @param { number } x - The offset point on x-axis. + * @param { number } y - The offset point on y-axis. + * @param { common2D.Color } color - The shadow color. The range of color channels must be [0, 255]. + * @returns { ShadowLayer } ShadowLayer object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static create(blurRadius: number, x: number, y: number, color: common2D.Color): ShadowLayer; + + /** + * Makes a new ShadowLayer with the specified ARGB color of hexadecimal format. + * + * @param { number } blurRadius - The blur radius of the shadow. The blur radius must be greater than 0. + * @param { number } x - The offset point on x-axis. + * @param { number } y - The offset point on y-axis. + * @param { number } color - The shadow color. Number must be ARGB color of hexadecimal format. + * @returns { ShadowLayer } ShadowLayer object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + static create(blurRadius: number, x: number, y: number, color: number): ShadowLayer; + } + + /** + * ColorFilters are optional objects in the drawing pipeline. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class ColorFilter { + /** + * Makes a color filter with the given color and blend mode. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. + * @param { BlendMode } mode - BlendMode. + * @returns { ColorFilter } Colorfilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static createBlendModeColorFilter(color: common2D.Color, mode: BlendMode): ColorFilter; + + /** + * Makes a color filter with the given ARGB color of hexadecimal format and blend mode. + * @param { number } color - Number must be ARGB color of hexadecimal format. + * @param { BlendMode } mode - BlendMode. + * @returns { ColorFilter } Colorfilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + static createBlendModeColorFilter(color: number, mode: BlendMode): ColorFilter; + + /** + * Create a color filter consisting of two filters. + * @param { ColorFilter } outer - The filter is used next. + * @param { ColorFilter } inner - The filter is used first. + * @returns { ColorFilter } Colorfilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static createComposeColorFilter(outer: ColorFilter, inner: ColorFilter): ColorFilter; + /** + * Makes a color filter that converts between linear colors and sRGB colors. + * @returns { ColorFilter } Colorfilter object. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static createLinearToSRGBGamma(): ColorFilter; + /** + * Makes a color filter that converts between sRGB colors and linear colors. + * @returns { ColorFilter } Colorfilter object. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static createSRGBGammaToLinear(): ColorFilter; + /** + * Makes a color filter that multiplies the luma of its input into the alpha channel, + * and sets the red, green, and blue channels to zero. + * @returns { ColorFilter } Colorfilter. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + static createLumaColorFilter(): ColorFilter; + /** + * Makes a color filter with a 5x4 color matrix + * @param { Array } matrix - Indicates the matrix, which is represented as a number array of length 20. + * @returns { ColorFilter } Colorfilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createMatrixColorFilter(matrix: Array): ColorFilter; + } + + /** + * ImageFilters are optional objects in the drawing pipeline. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class ImageFilter { + /** + * Makes an ImageFilter object that blurs its input by the separate X and Y sigmas. + * @param { number } sigmaX - Indicates the Gaussian sigma value for blurring along the X axis. Must be > 0. + * @param { number } sigmaY - Indicates the Gaussian sigma value for blurring along the Y axis. Must be > 0. + * @param { TileMode } tileMode - Indicates the tile mode applied at edges. + * @param { ImageFilter | null } imageFilter - Indicates the input filter that is blurred, + * uses source bitmap if this is null. + * @returns { ImageFilter } ImageFilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createBlurImageFilter(sigmaX: number, sigmaY: number, + tileMode: TileMode, imageFilter?: ImageFilter | null): ImageFilter; + /** + * Makes an ImageFilter object that applies the color filter to the input. + * @param { ColorFilter } colorFilter - Indicates the color filter that transforms the input image. + * @param { ImageFilter | null } imageFilter - Indicates the input filter, + * or uses the source bitmap if this is null. + * @returns { ImageFilter } ImageFilter object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + static createFromColorFilter(colorFilter: ColorFilter, imageFilter?: ImageFilter | null): ImageFilter; + } + /** + * Enumerate join styles. The join style defines the shape of the joins of a + * polyline segment drawn by the pen. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum JoinStyle { + /** + * Miter corner. If the angle of a polyline is small, its miter length may be inappropriate. + * In this case, you need to use the miter limit to limit the miter length. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + MITER_JOIN = 0, + + /** + * Round corner. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + ROUND_JOIN = 1, + + /** + * Bevel corner. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + BEVEL_JOIN = 2 + } + + /** + * Enumerates cap styles of a pen. The cap style defines + * the style of both ends of a segment drawn by the pen. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum CapStyle { + /** + * No cap style. Both ends of the segment are cut off square. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FLAT_CAP = 0, + + /** + * Square cap style. Both ends have a square, the height of which + * is half of the width of the segment, with the same width. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + SQUARE_CAP = 1, + + /** + * Round cap style. Both ends have a semicircle centered, the diameter of which + * is the same as the width of the segment. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + ROUND_CAP = 2 + } + + /** + * Enumerates blur type. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum BlurType { + /** + * Fuzzy inside and outside. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + NORMAL = 0, + + /** + * Solid inside, fuzzy outside. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + SOLID = 1, + + /** + * Nothing inside, fuzzy outside. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + OUTER = 2, + + /** + * Fuzzy inside, nothing outside. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + INNER = 3 + } + + /** + * Provides settings for strokes during drawing. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class Pen { + /** + * Constructor for the pen. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(); + + /** + * Constructor for the pen from an existing pen object pen. + * @param { Pen } pen - Indicates the Pen object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(pen: Pen); + + /** + * Sets the stroke miter limit for a polyline drawn by a pen. + * @param { number } miter - Indicates a variable that describes the miter limit. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setMiterLimit(miter: number): void; + + /** + * Obtains the stroke miter limit of a polyline drawn by a pen. + * @returns { number } Returns the miter limit. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getMiterLimit(): number; + + /** + * Sets the shaderEffect for a pen. + * @param { ShaderEffect } shaderEffect - Indicates the ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setShaderEffect(shaderEffect: ShaderEffect): void; + + /** + * Set the color of the pen. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setColor(color: common2D.Color): void; + + /** + * Set the specified ARGB color of hexadecimal format to the pen. + * @param { number } color - Number must be ARGB color of hexadecimal format. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + setColor(color: number): void; + + /** + * Set the AGRB color of the pen. + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @param { number } red - Red channel of color. The range of red must be [0, 255]. + * @param { number } green - Green channel of color. The range of green must be [0, 255]. + * @param { number } blue - Blue channel of color. The range of blue must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setColor(alpha: number, red: number, green: number, blue: number): void; + + /** + * Obtains the color of a pen. The color is used by the pen to outline a shape. + * @returns { common2D.Color } Returns a 32-bit (ARGB) variable that describes the color. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getColor(): common2D.Color; + + /** + * Obtains the color of a pen. The color is used by the pen to outline a shape. + * @returns { number } Returns a 32-bit (ARGB) variable that describes the color of hexadecimal format. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + getHexColor(): number; + + /** + * Sets the thickness of the pen used by the paint to outline the shape. + * + * @param { number } width - Zero thickness for hairline; greater than zero for pen thickness. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setStrokeWidth(width: number): void; + + /** + * Obtains the thickness of a pen. This thickness determines the width of the outline of a shape. + * @returns { number } Returns the thickness. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getWidth(): number; + + /** + * Requests, but does not require, that edge pixels draw opaque or with partial transparency. + * @param { boolean } aa - Setting for antialiasing. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setAntiAlias(aa: boolean): void; + + /** + * Checks whether anti-aliasing is enabled for a pen. If anti-aliasing is enabled, + * edges will be drawn with partial transparency. + * @returns { boolean } Returns true if the anti-aliasing is enabled; returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isAntiAlias(): boolean; + + /** + * Replaces alpha, leaving RGB + * + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setAlpha(alpha: number): void; + + /** + * Obtains the alpha of a pen. The alpha is used by the pen to outline a shape. + * @returns { number } Returns a 8-bit variable that describes the alpha. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getAlpha(): number; + + /** + * Sets ColorFilter to pen + * + * @param { ColorFilter } filter - ColorFilter to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setColorFilter(filter: ColorFilter): void; + /** + * Gets ColorFilter of pen + * @returns { ColorFilter } ColorFilter. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getColorFilter(): ColorFilter; + /** + * Sets ImageFilter to pen + * @param { ImageFilter | null } filter - ImageFilter to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setImageFilter(filter: ImageFilter | null): void; + /** + * Sets MaskFilter to pen. + * + * @param { MaskFilter } filter - MaskFilter to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setMaskFilter(filter: MaskFilter): void; + + /** + * Sets PathEffect to pen. + * + * @param { PathEffect } effect - PathEffect to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setPathEffect(effect: PathEffect): void; + + /** + * Sets ShadowLayer to pen. + * + * @param { ShadowLayer } shadowLayer - ShadowLayer to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setShadowLayer(shadowLayer: ShadowLayer): void; + + /** + * Sets a blender that implements the specified blendmode enum. + * + * @param { BlendMode } mode - Blendmode. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setBlendMode(mode: BlendMode): void; + + /** + * Request color distribution error. + * + * @param { boolean } dither - Whether the color is distributed incorrectly. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setDither(dither: boolean): void; + + /** + * Sets the JoinStyle for a pen. + * + * @param { JoinStyle } style - The JoinStyle. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setJoinStyle(style: JoinStyle): void; + + /** + * Obtains the JoinStyle of a pen. + * + * @returns { JoinStyle } The JoinStyle. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getJoinStyle(): JoinStyle; + + /** + * Sets the CapStyle for a pen. + * + * @param { CapStyle } style - The CapStyle. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setCapStyle(style: CapStyle): void; + + /** + * Obtains the CapStyle of a pen. + * + * @returns { CapStyle } The CapStyle. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getCapStyle(): CapStyle; + + /** + * Resets all pen contents to their initial values. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + reset(): void; + /** + * Obtains the filled equivalent of the src path. + * + * @param { Path } src - The path read to create a filled version. + * @param { Path } dst - The resulting path (may be the same as src). + * @returns { boolean } true if the path should be filled, + * or false if it should be drawn with a hairline (width == 0) + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getFillPath(src: Path, dst: Path): boolean; + } + + /** + * Provides settings for brush fill when drawing. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + export class Brush { + /** + * Constructor for the Brush. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(); + + /** + * Constructor for the Brush from an existing brush object brush. + * @param { Brush } brush - Indicates the Brush object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(brush: Brush); + + /** + * Set the color of the brush. + * @param { common2D.Color } color - The range of color channels must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setColor(color: common2D.Color): void; + + /** + * Set the specified ARGB color of hexadecimal format to the brush. + * @param { number } color - Number must be ARGB color of hexadecimal format. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + setColor(color: number): void; + + /** + * Set the ARGB color of the brush. + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @param { number } red - Red channel of color. The range of red must be [0, 255]. + * @param { number } green - Green channel of color. The range of green must be [0, 255]. + * @param { number } blue - Blue channel of color. The range of blue must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setColor(alpha: number, red: number, green: number, blue: number): void; + + /** + * Obtains the color of a brush. The color is used by the brush to fill in a shape. + * @returns { common2D.Color } Returns a 32-bit (ARGB) variable that describes the color. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getColor(): common2D.Color; + + /** + * Obtains the color of a brush. The color is used by the brush to fill in a shape. + * @returns { number } Returns a 32-bit (ARGB) variable that describes the color of hexadecimal format. + * @syscap SystemCapability.Graphics.Drawing + * @since 13 + */ + getHexColor(): number; + + /** + * Requests, but does not require, that edge pixels draw opaque or with partial transparency. + * @param { boolean } aa - Setting for antialiasing. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setAntiAlias(aa: boolean): void; + + /** + * Checks whether anti-aliasing is enabled for a brush. If anti-aliasing is enabled, + * edges will be drawn with partial transparency. + * @returns { boolean } Returns true if anti-aliasing is enabled; returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isAntiAlias(): boolean; + + /** + * Replaces alpha, leaving RGB + * @param { number } alpha - Alpha channel of color. The range of alpha must be [0, 255]. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setAlpha(alpha: number): void; + + /** + * Obtains the alpha of a brush. The alpha is used by the brush to fill in a shape. + * @returns { number } Returns a 8-bit variable that describes the alpha. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getAlpha(): number; + + /** + * Sets ColorFilter to brush + * @param { ColorFilter } filter - ColorFilter to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setColorFilter(filter: ColorFilter): void; + + /** + * Gets ColorFilter of brush + * @returns { ColorFilter } ColorFilter. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getColorFilter(): ColorFilter; + /** + * Sets ImageFilter to brush + * @param { ImageFilter | null } filter - ImageFilter to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setImageFilter(filter: ImageFilter | null): void; + /** + * Sets MaskFilter to brush. + * @param { MaskFilter } filter - MaskFilter to apply to subsequent draw. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setMaskFilter(filter: MaskFilter): void; + + /** + * Sets ShadowLayer to brush. + * + * @param { ShadowLayer } shadowLayer - ShadowLayer painting. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setShadowLayer(shadowLayer: ShadowLayer): void; + + /** + * Sets the shaderEffect for a brush. + * @param { ShaderEffect } shaderEffect - Indicates the ShaderEffect object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setShaderEffect(shaderEffect: ShaderEffect): void; + + /** + * Sets a blender that implements the specified blendmode enum. + * @param { BlendMode } mode - Blendmode. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 11 + */ + setBlendMode(mode: BlendMode): void; + + /** + * Resets all brush contents to their initial values. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + reset(): void; + } + + /** + * Declares functions related to the matrix object in the drawing module. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class Matrix { + /** + * Creates an identity matrix. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + constructor(); + + /** + * Sets matrix to rotate by degrees about a pivot point at (px, py). + * @param { number } degree - Indicates the angle of axes relative to upright axes. + * @param { number } px - Indicates the pivot on x-axis. + * @param { number } py - Indicates the pivot on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setRotation(degree: number, px: number, py: number): void; + + /** + * Sets matrix to scale by sx and sy, about a pivot point at (px, py). + * @param { number } sx - Indicates the horizontal scale factor. + * @param { number } sy - Indicates the vertical scale factor. + * @param { number } px - Indicates the pivot on x-axis. + * @param { number } py - Indicates the pivot on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setScale(sx: number, sy: number, px: number, py: number): void; + + /** + * Sets matrix to translate by (dx, dy). + * @param { number } dx - Indicates the horizontal translation. + * @param { number } dy - Indicates the vertical translation. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setTranslation(dx: number, dy: number): void; + + /** + * Sets the params for a matrix. + * @param { Array } values - Each value in the array represents the following parameters: + * values[0] - horizontal scale factor to store. + * values[1] - horizontal skew factor to store. + * values[2] - horizontal translation to store. + * values[3] - vertical skew factor to store. + * values[4] - vertical scale factor to store. + * values[5] - vertical translation to store. + * values[6] - input x-axis values perspective factor to store. + * values[7] - input y-axis values perspective factor to store. + * values[8] - perspective scale factor to store. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setMatrix(values: Array): void; + + /** + * Sets matrix total to matrix a multiplied by matrix b. + * @param { Matrix } matrix - Indicates the Matrix object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + preConcat(matrix: Matrix): void; + + /** + * Returns true if the first matrix equals the second matrix. + * @param { Matrix } matrix - Indicates the Matrix object. + * @returns { Boolean } Returns true if the two matrices are equal; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isEqual(matrix: Matrix): Boolean; + + /** + * Sets inverse to reciprocal matrix, returning true if matrix can be inverted. + * @param { Matrix } matrix - Indicates the Matrix object. + * @returns { Boolean } Returns true if matrix can be inverted; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + invert(matrix: Matrix): Boolean; + + /** + * Returns true if matrix is identity. + * @returns { Boolean } Returns true if matrix is identity; returns false otherwise. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isIdentity(): Boolean; + + /** + * Get one matrix value. Index is between the range of 0-8. + * @param { number } index - one of 0-8 + * @returns { number } Returns value corresponding to index.Returns 0 if out of range. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getValue(index: number): number; + /** + * Sets matrix to matrix multiplied by matrix constructed from rotating by degrees around pivot point (px, py). + * This can be thought of as rotating around a pivot point after applying matrix. + * @param { number } degree - Indicates the angle of axes relative to upright axes. + * @param { number } px - Indicates the pivot on x-axis. + * @param { number } py - Indicates the pivot on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + postRotate(degree: number, px: number, py: number): void; + /** + * Sets matrix to matrix multiplied by matrix constructed from scaling by (sx, sy) relative to pivot point (px, py). + * This can be thought of as scaling relative to a pivot point after applying matrix. + * @param { number } sx - Indicates the horizontal scale factor. + * @param { number } sy - Indicates the vertical scale factor. + * @param { number } px - Indicates the pivot on x-axis. + * @param { number } py - Indicates the pivot on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + postScale(sx: number, sy: number, px: number, py: number): void; + /** + * Sets matrix to matrix multiplied by matrix constructed from translation (dx, dy). + * This can be thought of as moving the point to be mapped after applying matrix. + * @param { number } dx - Indicates the horizontal translation. + * @param { number } dy - Indicates the vertical translation. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + postTranslate(dx: number, dy: number): void; + /** + * Sets matrix to matrix multiplied by matrix constructed from rotating by degrees around pivot point (px, py). + * This can be thought of as rotating around a pivot point before applying matrix. + * @param { number } degree - Indicates the angle of axes relative to upright axes. + * @param { number } px - Indicates the pivot on x-axis. + * @param { number } py - Indicates the pivot on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + preRotate(degree: number, px: number, py: number): void; + /** + * Sets matrix to matrix multiplied by matrix constructed from scaling by (sx, sy) relative to pivot point (px, py). + * This can be thought of as scaling relative to a pivot point before applying matrix. + * @param { number } sx - Indicates the horizontal scale factor. + * @param { number } sy - Indicates the vertical scale factor. + * @param { number } px - Indicates the pivot on x-axis. + * @param { number } py - Indicates the pivot on y-axis. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + preScale(sx: number, sy: number, px: number, py: number): void; + /** + * Sets matrix to matrix multiplied by matrix constructed from translation (dx, dy). + * This can be thought of as moving the point to be mapped before applying matrix. + * @param { number } dx - Indicates the horizontal translation. + * @param { number } dy - Indicates the vertical translation. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + preTranslate(dx: number, dy: number): void; + /** + * Reset matrix to identity. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + reset(): void; + /** + * Maps src array of length count to dst array of equal or greater length. + * This can be thought of as moving the point to be mapped before applying matrix. + * @param { Array } src - points to transform. + * @returns { Array } Return mapped points array. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + mapPoints(src: Array): Array; + /** + * Return nine scalar values contained by Matrix. + * @returns { Array } nine scalar values contained by Matrix. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + getAll(): Array; + /** + * Sets dst to bounds of src corners mapped by matrix transformation. + * @param { common2D.Rect } dst - Rect to map from. + * @param { common2D.Rect } src - Rect to map to. + * @returns { boolean } Returns true if the mapped src is equal to the dst; returns false is not equal. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + mapRect(dst: common2D.Rect, src: common2D.Rect): boolean; + /** + * Sets matrix to scale and translate src rect to dst rect. + * @param { common2D.Rect } src - Rect to map from. + * @param { common2D.Rect } dst - Rect to map to. + * @param { ScaleToFit } scaleToFit - Describes how matrix is constructed to map one rect to another. + * @returns { boolean } Returns true if dst is empty, and sets matrix to: + | 0 0 0 | + | 0 0 0 | + | 0 0 1 |. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3. Parameter verification failed. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setRectToRect(src: common2D.Rect, dst: common2D.Rect, scaleToFit: ScaleToFit): boolean; + /** + * Sets Matrix to map src to dst. Count must be zero or greater, and four or less. + * @param { Array } src - Point to map from + * @param { Array } dst - Point to map to + * @param { number } count - Number of Point in src and dst + * @returns { boolean } Returns true if Matrix was constructed successfully + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setPolyToPoly(src: Array, dst: Array, count: number): boolean; + } + + /** + * Describes a scale-to-fit values. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum ScaleToFit { + /** + * Scales in x and y to fill destination Rect. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FILL_SCALE_TO_FIT = 0, + + /** + * Scales and aligns to left and top. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + START_SCALE_TO_FIT = 1, + + /** + * Scales and aligns to center. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + CENTER_SCALE_TO_FIT = 2, + + /** + * Scales and aligns to right and bottom. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + END_SCALE_TO_FIT = 3 + } + + /** + * Describes a region object. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export class Region { + /** + * Determines whether the test point is in the region. + * @param { number } x - Indicates the x coordinate of the point. The parameter must be an integer. + * @param { number } y - Indicates the y coordinate of the point. The parameter must be an integer. + * @returns { boolean } Returns true if (x, y) is inside region; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isPointContained(x: number, y:number): boolean; + + /** + * Determines whether other region is in the region. + * @param { Region } other - Other region object. + * @returns { boolean } Returns true if other region is completely inside the region object; + *
returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + isRegionContained(other: Region): boolean; + + /** + * Replaces region with the result of region op region. + * @param { Region } region - Region object. + * @param { RegionOp } regionOp - Operation type. + * @returns { boolean } Returns true if replaced region is not empty; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + op(region: Region, regionOp: RegionOp): boolean; + + /** + * Determines whether rect and region does not intersect. + * @param { number } left - Left position of rectangle. The parameter must be an integer. + * @param { number } top - Top position of rectangle. The parameter must be an integer. + * @param { number } right - Right position of rectangle. The parameter must be an integer. + * @param { number } bottom - Bottom position of rectangle. The parameter must be an integer. + * @returns { boolean } Returns true if rect and region is not intersect; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + quickReject(left: number, top: number, right: number, bottom: number): boolean; + + /** + * Sets the region to match outline of path within clip. + * @param { Path } path - Providing outline. + * @param { Region } clip - Region object. + * @returns { boolean } Returns true if constructed region is not empty; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setPath(path: Path, clip: Region): boolean; + + /** + * Sets a rect to region. + * @param { number } left - Left position of rectangle. The parameter must be an integer. + * @param { number } top - Top position of rectangle. The parameter must be an integer. + * @param { number } right - Right position of rectangle. The parameter must be an integer. + * @param { number } bottom - Bottom position of rectangle. The parameter must be an integer. + * @returns { boolean } Returns true if constructed region is not empty; returns false otherwise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + setRect(left: number, top: number, right: number, bottom: number): boolean; + } + + /** + * Enumerates of operations when two regions are combined. + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum RegionOp { + /** + * Difference operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + DIFFERENCE = 0, + + /** + * Intersect operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + INTERSECT = 1, + + /** + * Union operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + UNION = 2, + + /** + * Xor operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + XOR = 3, + + /** + * Reverse difference operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + REVERSE_DIFFERENCE = 4, + + /** + * Replace operation. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + REPLACE = 5 + } + + /** + * Enumerates of corner radius position. + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum CornerPos { + /** + * Index of top-left corner radius. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + TOP_LEFT_POS = 0, + + /** + * Index of top-right corner radius. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + TOP_RIGHT_POS = 1, + + /** + * Index of bottom-right corner radius. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + BOTTOM_RIGHT_POS = 2, + + /** + * Index of bottom-left corner radius. + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + BOTTOM_LEFT_POS = 3 + } + + /** + * Enumeration defines the constraint type. + * + * @enum { number } + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + export enum SrcRectConstraint { + + /** + * Using sampling only inside bounds in a slower manner. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + STRICT = 0, + + /** + * Using sampling outside bounds in a faster manner. + * + * @syscap SystemCapability.Graphics.Drawing + * @since 12 + */ + FAST = 1 + } +} + +export default drawing; diff --git a/api/@ohos.graphics.hdrCapability.d.ts b/api/@ohos.graphics.hdrCapability.d.ts index 63db216d71c4e45e31b084fc1c22067b614be9fa..6b261e4f2b5d59a710fcfb81a60517f1a895cfbc 100644 --- a/api/@ohos.graphics.hdrCapability.d.ts +++ b/api/@ohos.graphics.hdrCapability.d.ts @@ -16,6 +16,7 @@ /** * @file * @kit ArkGraphics2D + * @arkts 1.1&1.2 */ import { AsyncCallback } from './@ohos.base'; @@ -33,7 +34,7 @@ import { AsyncCallback } from './@ohos.base'; * @namespace hdrCapability * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ declare namespace hdrCapability { /** @@ -49,7 +50,7 @@ declare namespace hdrCapability { * @enum { number } * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ enum HDRFormat { /** @@ -63,7 +64,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ NONE = 0, /** @@ -77,7 +78,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ VIDEO_HLG = 1, /** @@ -91,7 +92,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ VIDEO_HDR10 = 2, /** @@ -105,7 +106,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ VIDEO_HDR_VIVID = 3, /** @@ -119,7 +120,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ IMAGE_HDR_VIVID_DUAL = 4, /** @@ -133,7 +134,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ IMAGE_HDR_VIVID_SINGLE = 5, /** @@ -147,7 +148,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ IMAGE_HDR_ISO_DUAL = 6, /** @@ -161,7 +162,7 @@ declare namespace hdrCapability { * * @syscap SystemCapability.Graphic.Graphic2D.ColorManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} */ IMAGE_HDR_ISO_SINGLE = 7, } diff --git a/api/@ohos.graphics.scene.d.ts b/api/@ohos.graphics.scene.d.ts index 2d6b1d45679241d77858fcc109a881ef0d0d6c5c..2a9c9c6af18a971ed6a579762d86bbe26393dece 100644 --- a/api/@ohos.graphics.scene.d.ts +++ b/api/@ohos.graphics.scene.d.ts @@ -18,40 +18,10 @@ * @kit ArkGraphics3D */ -/** - * Export post processing settings - * @syscap SystemCapability.ArkUi.Graphics3D - * @since 12 - */ -export { ToneMappingType, ToneMappingSettings, PostProcessSettings, BloomSettings } from './graphics3d/ScenePostProcessSettings'; - -/** - * Export scene types - * @syscap SystemCapability.ArkUi.Graphics3D - * @since 12 - */ -export { Vec2, Vec3, Vec4, Color, Rect, Quaternion, Aabb, Position3, Rotation3, Scale3, GeometryType, GeometryDefinition, - PrimitiveTopology, CustomGeometry, CubeGeometry, PlaneGeometry, SphereGeometry } from './graphics3d/SceneTypes'; - -/** - * Export scene resources - * @syscap SystemCapability.ArkUi.Graphics3D - * @since 12 - */ -export { SceneResourceType, SceneResource, Shader, MaterialType, Material, ShaderMaterial, - SubMesh, Mesh, Animation, EnvironmentBackgroundType, Environment, Image, MeshResource } from './graphics3d/SceneResources'; - -/** - * Export scene nodes - * @syscap SystemCapability.ArkUi.Graphics3D - * @since 12 - */ -export { LayerMask, NodeType, Container, Node, Geometry, LightType, Light, SpotLight, DirectionalLight, - Camera } from './graphics3d/SceneNodes'; /** * Export scene * @syscap SystemCapability.ArkUi.Graphics3D - * @since 12 + * @since arkts {'1.1':'7', '1.2':'20'} */ -export { SceneResourceParameters, SceneNodeParameters, SceneResourceFactory, Scene, RenderParameters } from './graphics3d/Scene'; +export { Scene } from './graphics3d/Scene'; diff --git a/api/@ohos.graphics.text.d.ts b/api/@ohos.graphics.text.d.ts index edaf344f7d730927357d90f5ef2d9aa4098d1b98..9c176caa88f28f0ec7012518e7c4852571145196 100755 --- a/api/@ohos.graphics.text.d.ts +++ b/api/@ohos.graphics.text.d.ts @@ -19,13 +19,17 @@ */ import type drawing from './@ohos.graphics.drawing'; import type common2D from './@ohos.graphics.common2D'; +/*** if arkts 1.2 */ +import { Resource } from './global/resource'; +/*** endif */ /** * Provides functions such as 2D graphics text paragraphs, text styles. * * @namespace text * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace text { @@ -33,48 +37,55 @@ declare namespace text { * Refers to how to align the horizontal position of text when displaying text. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TextAlign { /** * Use the left side of the text as a reference line for alignment. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LEFT = 0, /** * Use the right side of the text as a reference line for alignment. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT = 1, /** * Use the midpoint line the text as a reference line for alignment. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER = 2, /** * Align the text at the start and end of the line. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ JUSTIFY = 3, /** * Align text from start, based on the direction of text, such as left-to-right or right-to-left. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START = 4, /** * Align text from end, based on the direction of text, such as left-to-right or right-to-left, opposite to START. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END = 5, } @@ -83,20 +94,23 @@ declare namespace text { * Enumerate text runs direction. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TextDirection { /** * The text is oriented from right to left. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RTL, /** * The text is oriented from left to right. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LTR, } @@ -105,27 +119,31 @@ declare namespace text { * Enumerate text segmentation strategy. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum BreakStrategy { /** * The segmentation strategy is greedy. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GREEDY, /** * The segmentation strategy is high quality. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH_QUALITY, /** * The segmentation strategy is balanced. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BALANCED, } @@ -134,34 +152,39 @@ declare namespace text { * Enumerate word break strategy. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum WordBreak { /** * Normal word break strategy. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL, /** * Breaks word by character. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BREAK_ALL, /** * Breaks word by phrase. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BREAK_WORD, /** * Breaks word by hyphen. * @syscap SystemCapability.Graphics.Drawing - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ BREAK_HYPHEN, } @@ -170,14 +193,16 @@ declare namespace text { * Decoration for text. * @typedef Decoration * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface Decoration { /** * Decorates text by line. * @type { ?TextDecorationType } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textDecoration?: TextDecorationType; @@ -185,7 +210,8 @@ declare namespace text { * Text color. * @type { ?common2D.Color } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: common2D.Color; @@ -193,7 +219,8 @@ declare namespace text { * Text decoration style. * @type { ?TextDecorationStyle } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decorationStyle?: TextDecorationStyle; @@ -201,7 +228,8 @@ declare namespace text { * The thickness scale of decoration line. * @type { ?number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decorationThicknessScale?: number; } @@ -210,34 +238,39 @@ declare namespace text { * Enumerates decoration line for text. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TextDecorationType { /** * There are no text decoration. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NONE, /** * There is a decoration line below the text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UNDERLINE, /** * There is a decoration line above the text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OVERLINE, /** * There is a decoration line through the middle of the text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LINE_THROUGH, } @@ -246,41 +279,47 @@ declare namespace text { * Enumerates decoration line style. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TextDecorationStyle { /** * Decoration line is solid line. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOLID, /** * Decoration line is double line. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOUBLE, /** * Decoration line is dotted line. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DOTTED, /** * Decoration line is dashed line. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DASHED, /** * Decoration line is wavy line. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WAVY, } @@ -289,69 +328,79 @@ declare namespace text { * Enumeration of font weight of text. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum FontWeight { /** * Thin * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W100, /** * Extra-light * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W200, /** * Light * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W300, /** * Normal/Regular * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W400, /** * Medium * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W500, /** * Semi-bold * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W600, /** * Bold * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W700, /** * Extra-bold * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W800, /** * Black * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ W900, } @@ -360,27 +409,31 @@ declare namespace text { * Enumeration of font style of text. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum FontStyle { /** * Upright font type. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL, /** * Slant font. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ITALIC, /** * Oblique font. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OBLIQUE, } @@ -389,69 +442,79 @@ declare namespace text { * Enumeration of font width of text. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum FontWidth { /** * Ultra condensed font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ULTRA_CONDENSED = 1, /** * Extra condensed font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXTRA_CONDENSED = 2, /** * Condensed font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONDENSED = 3, /** * Semi condensed font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SEMI_CONDENSED = 4, /** * Normal font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL = 5, /** * Semi expanded font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SEMI_EXPANDED = 6, /** * Expanded font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPANDED = 7, /** * Extra expanded font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXTRA_EXPANDED = 8, /** * Ultra expanded font width. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ULTRA_EXPANDED = 9, } @@ -460,34 +523,39 @@ declare namespace text { * Enumerates of height mode of text. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TextHeightBehavior { /** * Both ascend of first row and last row style. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALL = 0x0, /** * Forbidding ascend of first row style. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISABLE_FIRST_ASCENT = 0x1, /** * Forbidding ascend of last row style. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISABLE_LAST_ASCENT = 0x2, /** * Neither ascend of first row nor last row style. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISABLE_ALL = 0x1 | 0x2, } @@ -496,14 +564,16 @@ declare namespace text { * Enumeration the type of text baseline. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TextBaseline { /** * The alphabetic baseline, typically used for Latin-based scripts where the baseline aligns * with the base of lowercase letters. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALPHABETIC, @@ -511,7 +581,8 @@ declare namespace text { * The ideographic baseline, commonly used for ideographic scripts such as Chinese, Japanese, and Korean, * where the baseline aligns with the center of characters. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IDEOGRAPHIC, } @@ -520,27 +591,31 @@ declare namespace text { * Enumerates of ellipsis mode. * @enum { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum EllipsisMode { /** * The ellipsis is shown in the start of text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ START, /** * The ellipsis is shown in the middle of text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE, /** * The ellipsis is shown in the end of text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ END, } @@ -549,28 +624,32 @@ declare namespace text { * Describes shadow of text. * @typedef TextShadow * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextShadow { /** * The color of text shadow. * @type { ?common2D.Color } The color of text shadow * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: common2D.Color; /** * The value sets offset of text shadow that based on the original text. * @type { ?common2D.Point } The point of shadow * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ point?: common2D.Point; /** * The value sets special effect radius of blurring text, it default is 0. * @type { ?number } The value about radius of blur, it type is "double" * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ blurRadius?: number; } @@ -579,14 +658,16 @@ declare namespace text { * Describes rect style of text. * @typedef RectStyle * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RectStyle { /** * The color of rect style. * @type { common2D.Color } The color of rect style * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color: common2D.Color; @@ -594,7 +675,8 @@ declare namespace text { * Radius in left top of rect style. * @type { number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ leftTopRadius: number; @@ -602,7 +684,8 @@ declare namespace text { * Radius in right top of rect style. * @type { number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rightTopRadius: number; @@ -610,7 +693,8 @@ declare namespace text { * Radius in right bottom of rect style. * @type { number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rightBottomRadius: number; @@ -618,7 +702,8 @@ declare namespace text { * Radius in left bottom of rect style. * @type { number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ leftBottomRadius: number; } @@ -627,21 +712,24 @@ declare namespace text { * Describes font feature of text. * @typedef FontFeature * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FontFeature { /** * The name of font feature. * @type { string } feature name * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; /** * The value of font feature. * @type { number } feature value * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ value: number; } @@ -650,21 +738,24 @@ declare namespace text { * Describes font variation of text. * @typedef FontVariation * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FontVariation { /** * The axis of font variation. * @type { string } variation axis * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ axis: string; /** * The value of font variation. * @type { number } variation value * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ value: number; } @@ -673,7 +764,8 @@ declare namespace text { * Describes text style. * @typedef TextStyle * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextStyle { @@ -681,7 +773,8 @@ declare namespace text { * Decoration of text. * @type { ?Decoration } decoration for text * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ decoration?: Decoration; @@ -689,7 +782,8 @@ declare namespace text { * Color of text. * @type { ?common2D.Color } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ color?: common2D.Color; @@ -697,7 +791,8 @@ declare namespace text { * Font weight of text. * @type { ?FontWeight } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: FontWeight; @@ -705,7 +800,8 @@ declare namespace text { * Font style of text. * @type { ?FontStyle } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle?: FontStyle; @@ -713,7 +809,8 @@ declare namespace text { * Base line of text. * @type { ?TextBaseline } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ baseline?: TextBaseline; @@ -721,7 +818,8 @@ declare namespace text { * Font Families of text. * @type { ?Array } fontfamily gather * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamilies?: Array; @@ -729,7 +827,8 @@ declare namespace text { * Font size of text. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: number; @@ -737,7 +836,8 @@ declare namespace text { * Letter spacing of text. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing?: number; @@ -745,7 +845,8 @@ declare namespace text { * Word spacing of text. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordSpacing?: number; @@ -753,7 +854,8 @@ declare namespace text { * Height scale of text. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ heightScale?: number; @@ -761,7 +863,8 @@ declare namespace text { * Half leading of text. * @type { ?boolean } it is boolean type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading?: boolean; @@ -770,7 +873,8 @@ declare namespace text { * the font size, false means by the line height and leading. * @type { ?boolean } it is boolean type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ heightOnly?: boolean; @@ -778,7 +882,8 @@ declare namespace text { * Text ellipsis. * @type { ?string } it is u16string type data. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ellipsis?: string; @@ -786,7 +891,8 @@ declare namespace text { * Text ellipsis mode. * @type { ?EllipsisMode } Ellipsis mode. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ellipsisMode?: EllipsisMode; @@ -794,7 +900,8 @@ declare namespace text { * Text locale. * @type { ?string } it is string type data. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -802,7 +909,8 @@ declare namespace text { * The offset distance that the underline of text. * @type { ?number } it is double type data. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ baselineShift?: number; @@ -810,7 +918,8 @@ declare namespace text { * Text Style available font features. * @type { ?Array } A collection of font features. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFeatures?: Array; @@ -818,7 +927,8 @@ declare namespace text { * Text shadows of text. * @type { ?Array } textShadow gather. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textShadows?: Array; @@ -826,7 +936,8 @@ declare namespace text { * Rect style of text. * @type { ?RectStyle } rect style for text. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundRect?: RectStyle; @@ -834,7 +945,8 @@ declare namespace text { * Text Style available font variations. * @type { ?Array } A collection of font variations. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontVariations?: Array; } @@ -842,14 +954,16 @@ declare namespace text { /** * Provides the basis for graphics. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class FontCollection { /** * Get global FontCollection instance of the application. * @returns { FontCollection } The FontCollection object. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ static getGlobalInstance(): FontCollection; @@ -858,7 +972,8 @@ declare namespace text { * @param { string } name - the font name. * @param { string | Resource } path - the path of the font file. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ loadFontSync(name: string, path: string | Resource): void; @@ -870,14 +985,16 @@ declare namespace text { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types. * @syscap SystemCapability.Graphics.Drawing - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ loadFont(name: string, path: string | Resource): Promise; /** * Clear font caches. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clearCaches(): void; } @@ -886,14 +1003,16 @@ declare namespace text { * Describes strut style. * @typedef StrutStyle * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface StrutStyle { /** * The families of the font to use when calculating the strut. * @type { ?Array } fontfamily gather * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamilies?: Array; @@ -901,7 +1020,8 @@ declare namespace text { * The font style to use when calculating the strut. * @type { ?FontStyle } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle?: FontStyle; @@ -909,7 +1029,8 @@ declare namespace text { * The font width to use when calculating the strut. * @type { ?FontWidth } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWidth?: FontWidth; @@ -917,7 +1038,8 @@ declare namespace text { * The font weight to use when calculating the strut. * @type { ?FontWeight } it is uint32_t type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: FontWeight; @@ -925,7 +1047,8 @@ declare namespace text { * The size of the ascent plus descent in logical pixels. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: number; @@ -933,7 +1056,8 @@ declare namespace text { * The minimum height of the strut, as a multiple of fontSize. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height?: number; @@ -941,7 +1065,8 @@ declare namespace text { * The additional leading to apply to the strut as a multiple of Size. * @type { ?number } it is double type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ leading?: number; @@ -949,7 +1074,8 @@ declare namespace text { * Whether the strut height should be forced. * @type { ?boolean } it is boolean type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ forceHeight?: boolean; @@ -957,7 +1083,8 @@ declare namespace text { * Whether the strut style should be enable. * @type { ?boolean } it is boolean type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enabled?: boolean; @@ -965,7 +1092,8 @@ declare namespace text { * Whether the height is override. * @type { ?boolean } it is boolean type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ heightOverride?: boolean; @@ -973,7 +1101,8 @@ declare namespace text { * Whether the half leading is enable. * @type { ?boolean } it is boolean type data * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ halfLeading?: boolean; } @@ -982,14 +1111,16 @@ declare namespace text { * Determines the configuration used by ParagraphBuilder to position lines within a Paragraph of text. * @typedef ParagraphStyle * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ParagraphStyle { /** * Text style of paragraph. * @type { ?TextStyle } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle?: TextStyle; @@ -997,7 +1128,8 @@ declare namespace text { * Text runs direction. * @type { ?TextDirection } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textDirection?: TextDirection; @@ -1005,7 +1137,8 @@ declare namespace text { * Refers to how to align the horizontal position of text when displaying text. * @type { ?TextAlign } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ align?: TextAlign; @@ -1013,7 +1146,8 @@ declare namespace text { * Word break strategy. * @type { ?WordBreak } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak?: WordBreak; @@ -1021,7 +1155,8 @@ declare namespace text { * Maximum number of lines. * @type { ?number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maxLines?: number; @@ -1029,7 +1164,8 @@ declare namespace text { * text segmentation strategy. * @type { ?BreakStrategy } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ breakStrategy?: BreakStrategy; @@ -1037,7 +1173,8 @@ declare namespace text { * Strut style of paragraph. * @type { ?StrutStyle } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ strutStyle?: StrutStyle; @@ -1045,7 +1182,8 @@ declare namespace text { * Text height behavior of paragraph. * @type { ?TextHeightBehavior } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textHeightBehavior?: TextHeightBehavior; @@ -1056,7 +1194,8 @@ declare namespace text { * according to this tab effect. * @type { ?TextTab } * @syscap SystemCapability.Graphics.Drawing - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ tab?: TextTab; } @@ -1322,14 +1461,16 @@ declare namespace text { /** * A paragraph retains the size and position of each glyph in the text and can be efficiently resized and painted. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class Paragraph { /** * Calculates the positioning of all the glyphs. * @param { number } width - Control how wide the text is allowed to be. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ layoutSync(width: number): void; @@ -1350,7 +1491,8 @@ declare namespace text { * @param { number } x - Represents the X-axis position on the canvas. * @param { number } y - Represents the Y-axis position on the canvas. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ paint(canvas: drawing.Canvas, x: number, y: number): void; @@ -1361,7 +1503,8 @@ declare namespace text { * @param { number } hOffset - Horizontal offset along the path. * @param { number } vOffset - Vertical offset along the path. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ paintOnPath(canvas: drawing.Canvas, path: drawing.Path, hOffset: number, vOffset: number): void; @@ -1385,7 +1528,8 @@ declare namespace text { * Get the longest line of horizontal space this paragraph occupies. * @returns { number } The longest line of horizontal space this paragraph occupies. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLongestLine(): number; @@ -1524,7 +1668,8 @@ declare namespace text { * Returns the array of line metrics for a line of text. * @returns { Array } Array of line metrics. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLineMetrics(): Array; @@ -1533,7 +1678,8 @@ declare namespace text { * @param { number } lineNumber - a line number * @returns { LineMetrics | undefined } line metrics. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getLineMetrics(lineNumber: number): LineMetrics | undefined; } @@ -1717,7 +1863,8 @@ declare namespace text { /** * Builds a Paragraph containing text with the given styling information. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ class ParagraphBuilder { /** @@ -1733,14 +1880,16 @@ declare namespace text { * Push a style to the stack. * @param { TextStyle } textStyle - Text style {@link TextStyle} * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pushStyle(textStyle: TextStyle): void; /** * Remove a style from the stack. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ popStyle(): void; @@ -1748,7 +1897,8 @@ declare namespace text { * Adds text to the builder. * @param { string } text - Text string * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ addText(text: string): void; @@ -1764,7 +1914,8 @@ declare namespace text { * Create paragraph object. * @returns { Paragraph } The paragraph value returned to the caller. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ build(): Paragraph; @@ -2086,14 +2237,16 @@ declare namespace text { * Describes the layout information and metrics for a continuous piece of text (a run) in a line of text. * @typedef RunMetrics * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RunMetrics { /** * The metrics of an Font. * @type { TextStyle } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textStyle: TextStyle; @@ -2101,7 +2254,8 @@ declare namespace text { * Describes text style. * @type { drawing.FontMetrics } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontMetrics: drawing.FontMetrics; } @@ -2110,14 +2264,16 @@ declare namespace text { * Describes the metric information for a line of text in a text layout. * @typedef LineMetrics * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface LineMetrics { /** * The indexes in the text buffer the line begins. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ startIndex: number; @@ -2125,7 +2281,8 @@ declare namespace text { * The indexes in the text buffer the line ends. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ endIndex: number; @@ -2133,7 +2290,8 @@ declare namespace text { * The height of the text rise, the distance from the baseline to the top of the character. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ascent: number; @@ -2141,7 +2299,8 @@ declare namespace text { * The height of the text drop, the distance from the baseline to the bottom of the character. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ descent: number; @@ -2149,7 +2308,8 @@ declare namespace text { * The height of the current line is `round(ascent + descent)`. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -2157,7 +2317,8 @@ declare namespace text { * Width of the line. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -2165,7 +2326,8 @@ declare namespace text { * The left edge of the line. The right edge can be obtained with `left + width`. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ left: number; @@ -2173,7 +2335,8 @@ declare namespace text { * The y position of the baseline for this line from the top of the paragraph. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ baseline: number; @@ -2181,7 +2344,8 @@ declare namespace text { * Zero indexed line number. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineNumber: number; @@ -2189,7 +2353,8 @@ declare namespace text { * Height from the top. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ topHeight: number; @@ -2199,7 +2364,8 @@ declare namespace text { * are before layout and are the base values we calculate from. * @type { Map } * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ runMetrics: Map; } @@ -2245,7 +2411,8 @@ declare namespace text { * Text tab contains alignment type and location in paragraph style. * @typedef TextTab * @syscap SystemCapability.Graphics.Drawing - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface TextTab { /** @@ -2253,15 +2420,17 @@ declare namespace text { * other enumeration values are left alignment effect. * @type { TextAlign } * @syscap SystemCapability.Graphics.Drawing - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ alignment: TextAlign; - + /** * The position of the tab relative to the start of the line. * @type { number } * @syscap SystemCapability.Graphics.Drawing - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ location: number; } diff --git a/api/@ohos.graphics.uiEffect.d.ts b/api/@ohos.graphics.uiEffect.d.ts index e8e5fd8aac6c9d5817d07e5bd979b0ade1b75eb0..b30a33873168c441df807c6ffd04d04b17e34187 100644 --- a/api/@ohos.graphics.uiEffect.d.ts +++ b/api/@ohos.graphics.uiEffect.d.ts @@ -24,15 +24,16 @@ import { AsyncCallback } from './@ohos.base'; /** * @namespace uiEffect * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace uiEffect { - /** * The Filter for Component. * @typedef Filter * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface Filter { /** @@ -228,7 +229,8 @@ declare namespace uiEffect { * The VisualEffect of Component. * @typedef VisualEffect * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface VisualEffect { /** @@ -237,7 +239,8 @@ declare namespace uiEffect { * @returns { VisualEffect } VisualEffects for the current effect have been added. * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColorBlender(blender: BrightnessBlender): VisualEffect; } @@ -247,7 +250,8 @@ declare namespace uiEffect { * @typedef { BrightnessBlender } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ type Blender = BrightnessBlender; @@ -256,7 +260,8 @@ declare namespace uiEffect { * @typedef BrightnessBlender * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface BrightnessBlender { /** @@ -265,7 +270,8 @@ declare namespace uiEffect { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ cubicRate: number; @@ -275,7 +281,8 @@ declare namespace uiEffect { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ quadraticRate: number; @@ -285,7 +292,8 @@ declare namespace uiEffect { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ linearRate: number; @@ -295,7 +303,8 @@ declare namespace uiEffect { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ degree: number; @@ -305,7 +314,8 @@ declare namespace uiEffect { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ saturation: number; @@ -315,7 +325,8 @@ declare namespace uiEffect { * @type { [number, number, number] } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ positiveCoefficient: [number, number, number]; @@ -325,7 +336,8 @@ declare namespace uiEffect { * @type { [number, number, number] } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ negativeCoefficient: [number, number, number]; @@ -335,7 +347,8 @@ declare namespace uiEffect { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fraction: number; } @@ -352,7 +365,8 @@ declare namespace uiEffect { * Create a VisualEffect to add multiple effects to the component. * @returns { VisualEffect } Returns the head node of visualEffect. * @syscap SystemCapability.Graphics.Drawing - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function createEffect(): VisualEffect; @@ -362,7 +376,8 @@ declare namespace uiEffect { * @returns { BrightnessBlender } Returns the blender. * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function createBrightnessBlender(param: BrightnessBlenderParam): BrightnessBlender; } @@ -372,7 +387,8 @@ declare namespace uiEffect { * @typedef BrightnessBlenderParam * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare interface BrightnessBlenderParam { /** @@ -381,7 +397,8 @@ declare interface BrightnessBlenderParam { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ cubicRate: number; @@ -391,7 +408,8 @@ declare interface BrightnessBlenderParam { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ quadraticRate: number; @@ -401,7 +419,8 @@ declare interface BrightnessBlenderParam { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ linearRate: number; @@ -411,7 +430,8 @@ declare interface BrightnessBlenderParam { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ degree: number; @@ -421,7 +441,8 @@ declare interface BrightnessBlenderParam { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ saturation: number; @@ -431,7 +452,8 @@ declare interface BrightnessBlenderParam { * @type { [number, number, number] } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ positiveCoefficient: [number, number, number]; @@ -441,7 +463,8 @@ declare interface BrightnessBlenderParam { * @type { [number, number, number] } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ negativeCoefficient: [number, number, number]; @@ -451,7 +474,8 @@ declare interface BrightnessBlenderParam { * @type { number } * @syscap SystemCapability.Graphics.Drawing * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fraction: number; } diff --git a/api/@ohos.hiSysEvent.d.ts b/api/@ohos.hiSysEvent.d.ts index f4401ee2f08647989b3fc08d8c27a9d9fb82a0bf..2a08c051c8f5e72bd5f800b6e87c62fa89fc7045 100644 --- a/api/@ohos.hiSysEvent.d.ts +++ b/api/@ohos.hiSysEvent.d.ts @@ -28,7 +28,8 @@ import { AsyncCallback } from './@ohos.base'; * @namespace hiSysEvent * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace hiSysEvent { /** @@ -37,7 +38,8 @@ declare namespace hiSysEvent { * @enum {number} * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum EventType { /** @@ -45,7 +47,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ FAULT = 1, @@ -54,7 +57,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ STATISTIC = 2, @@ -63,7 +67,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SECURITY = 3, @@ -72,7 +77,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ BEHAVIOR = 4 } @@ -83,7 +89,8 @@ declare namespace hiSysEvent { * @interface SysEventInfo * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface SysEventInfo { /** @@ -92,7 +99,8 @@ declare namespace hiSysEvent { * @type { string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ domain: string; @@ -102,7 +110,8 @@ declare namespace hiSysEvent { * @type { string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -112,7 +121,8 @@ declare namespace hiSysEvent { * @type { EventType } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ eventType: EventType; @@ -130,7 +140,8 @@ declare namespace hiSysEvent { * @type { ?object } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ params?: object; } @@ -154,7 +165,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200054 - The number of event parameters of the array type exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function write(info: SysEventInfo): Promise; @@ -177,7 +189,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200054 - The number of event parameters of the array type exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function write(info: SysEventInfo, callback: AsyncCallback): void; @@ -187,7 +200,8 @@ declare namespace hiSysEvent { * @enum {number} * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum RuleType { /** @@ -195,7 +209,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ WHOLE_WORD = 1, @@ -204,7 +219,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ PREFIX = 2, @@ -213,7 +229,8 @@ declare namespace hiSysEvent { * * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ REGULAR = 3 } @@ -224,7 +241,8 @@ declare namespace hiSysEvent { * @interface WatchRule * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface WatchRule { /** @@ -233,7 +251,8 @@ declare namespace hiSysEvent { * @type { string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ domain: string; @@ -243,7 +262,8 @@ declare namespace hiSysEvent { * @type { string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -261,7 +281,8 @@ declare namespace hiSysEvent { * @type { ?string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ tag?: string; @@ -271,7 +292,8 @@ declare namespace hiSysEvent { * @type { RuleType } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ ruleType: RuleType; } @@ -282,7 +304,8 @@ declare namespace hiSysEvent { * @interface Watcher * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface Watcher { /** @@ -291,7 +314,8 @@ declare namespace hiSysEvent { * @type { WatchRule[] } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ rules: WatchRule[]; @@ -301,7 +325,8 @@ declare namespace hiSysEvent { * @type { function } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ onEvent: (info: SysEventInfo) => void; @@ -311,7 +336,8 @@ declare namespace hiSysEvent { * @type { function } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ onServiceDied: () => void; } @@ -322,7 +348,8 @@ declare namespace hiSysEvent { * @interface QueryArg * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface QueryArg { /** @@ -331,7 +358,8 @@ declare namespace hiSysEvent { * @type { number } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ beginTime: number; @@ -341,7 +369,8 @@ declare namespace hiSysEvent { * @type { number } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ endTime: number; @@ -351,7 +380,8 @@ declare namespace hiSysEvent { * @type { number } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ maxEvents: number; @@ -361,7 +391,8 @@ declare namespace hiSysEvent { * @type { ?number } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ fromSeq?: number; @@ -371,7 +402,8 @@ declare namespace hiSysEvent { * @type { ?number } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ toSeq?: number; } @@ -382,7 +414,8 @@ declare namespace hiSysEvent { * @interface QueryRule * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface QueryRule { /** @@ -391,7 +424,8 @@ declare namespace hiSysEvent { * @type { string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ domain: string; @@ -401,7 +435,8 @@ declare namespace hiSysEvent { * @type { string[] } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ names: string[]; @@ -411,7 +446,8 @@ declare namespace hiSysEvent { * @type { ?string } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ condition?: string; } @@ -422,7 +458,8 @@ declare namespace hiSysEvent { * @interface Querier * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface Querier { /** @@ -431,7 +468,8 @@ declare namespace hiSysEvent { * @type { function } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ onQuery: (infos: SysEventInfo[]) => void; @@ -441,7 +479,8 @@ declare namespace hiSysEvent { * @type { function } * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ onComplete: (reason: number, total: number) => void; } @@ -461,7 +500,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200102 - The number of watch rules exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function addWatcher(watcher: Watcher): void; @@ -479,7 +519,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200201 - The watcher does not exist. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function removeWatcher(watcher: Watcher): void; @@ -502,7 +543,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200304 - The query frequency exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function query(queryArg: QueryArg, rules: QueryRule[], querier: Querier): void; @@ -524,7 +566,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200304 – The query frequency exceeds the limit. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function exportSysEvents(queryArg: QueryArg, rules: QueryRule[]): number; @@ -544,7 +587,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200302 - Invalid query rule. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function subscribe(rules: QueryRule[]): number; @@ -561,7 +605,8 @@ declare namespace hiSysEvent { * @throws {BusinessError} 11200305 – Unsubscription failed. * @syscap SystemCapability.HiviewDFX.HiSysEvent * @systemapi hide for inner use - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function unsubscribe(): void; } diff --git a/api/@ohos.hiTraceChain.d.ets b/api/@ohos.hiTraceChain.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..720a7bb6cb02dc8b6e0f589f95227e9808305056 --- /dev/null +++ b/api/@ohos.hiTraceChain.d.ets @@ -0,0 +1,342 @@ +/* + * Copyright (c) 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 PerformanceAnalysisKit + */ + +/** + * Provides APIs to implement call chain tracing throughout a service process. + * With HiTrace, you can quickly obtain the run log for the call chain of a + * specified service process and locate faults in cross-device, cross-process, + * or cross-thread communications. + * + * @namespace hiTraceChain + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ +declare namespace hiTraceChain { + /** + * Enumerate trace flag + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export enum HiTraceFlag { + /** + * Default value + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + DEFAULT = 0, + + /** + * Trace sync and async call. default: trace sync call only. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + INCLUDE_ASYNC = 1, + + /** + * Do not create child span. default: create child span. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + DONOT_CREATE_SPAN = 1 << 1, + + /** + * Output tracepoint info in span. default: do not output tracepoint info. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + TP_INFO = 1 << 2, + + /** + * Do not output begin and end info. default: output begin and end info. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + NO_BE_INFO = 1 << 3, + + /** + * Do not add id to log. default: add id to log. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + DISABLE_LOG = 1 << 4, + + /** + * The trace is triggered by fault. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + FAILURE_TRIGGER = 1 << 5, + + /** + * Output device-to-device tracepoint info in span only. default: do not output device-to-device tracepoint info. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + D2D_TP_INFO = 1 << 6 + } + + /** + * Enumerate trace point type + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export enum HiTraceTracepointType { + /** + * Client send + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + CS = 0, + + /** + * Client receive + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + CR = 1, + + /** + * Server send + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + SS = 2, + + /** + * Server receive + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + SR = 3, + + /** + * General info + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + GENERAL = 4 + } + + /** + * Enumerate trace communication mode + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export enum HiTraceCommunicationMode { + /** + * Unspecified + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + DEFAULT = 0, + + /** + * Thread-to-thread + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + THREAD = 1, + + /** + * Process-to-process + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + PROCESS = 2, + + /** + * Device-to-device + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + DEVICE = 3 + } + + /** + * Trace id, for tracing process. + * + * @interface HiTraceId + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export interface HiTraceId { + /** + * Chain id. + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + chainId: bigint; + + /** + * Span id. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + spanId?: number; + + /** + * Parent span id. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + parentSpanId?: number; + + /** + * Trace flag. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + flags?: number; + } + + /** + * Start tracing a process impl. + * + * @param { string } name Process name. + * @param { number } flags Trace function flag. + * @returns { HiTraceId } Valid if first call, otherwise invalid. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function begin(name: string, flags?: number): HiTraceId; + + /** + * Stop process tracing and clear trace id of current thread if the given trace + * id is valid, otherwise do nothing. + * + * @param { HiTraceId } id The trace id that need to stop. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function end(id: HiTraceId): void; + + /** + * Get trace id of current thread, and return a invalid trace id if no + * trace id belong to current thread + * + * @returns { HiTraceId } Valid if current thread have a trace id, otherwise invalid. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function getId(): HiTraceId; + + /** + * Set id as trace id of current thread. Do nothing if id is invalid. + * + * @param { HiTraceId } id Set id as trace id of current thread. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function setId(id: HiTraceId): void; + + /** + * Clear trace id of current thread and set it invalid. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function clearId(): void; + + /** + * Create a new span id according to the trace id of current thread. + * + * @returns { HiTraceId } A valid span trace id. Otherwise trace id of current thread if do not allow create span. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function createSpan(): HiTraceId; + + /** + * Print hitrace info, include trace id info. + * + * @param { HiTraceCommunicationMode } mode Trace communication mode. + * @param { HiTraceTracepointType } type Trace info type. + * @param { HiTraceId } id Trace id that need to print. + * @param { string } msg Customized info that need to print. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function tracepoint(mode: HiTraceCommunicationMode, + type: HiTraceTracepointType, id: HiTraceId, msg?: string): void; + + /** + * Judge whether the trace id is valid or not. + * + * @param { HiTraceId } id Trace id that need to judge. + * @returns { boolean } True for a valid trace id, otherwise false. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function isValid(id: HiTraceId): boolean; + + /** + * Judge whether the trace id has enabled a trace flag or not. + * + * @param { HiTraceId } id Trace id that need to judge. + * @param { HiTraceFlag } flag Trace flag that need to judge. + * @returns { boolean } true if the trace id has enabled the flag. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean; + + /** + * Enable the designative trace flag for the trace id. + * + * @param { HiTraceId } id Trace id that need to enable a flag. + * @param { HiTraceFlag } flag the designative trace flag that need to be enabled in the trace id. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + export function enableFlag(id: HiTraceId, flag: HiTraceFlag): void; +} + +export default hiTraceChain; diff --git a/api/@ohos.hiTraceMeter.d.ets b/api/@ohos.hiTraceMeter.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..86bab093e0ab1e4ef38351535867d49de499a4f5 --- /dev/null +++ b/api/@ohos.hiTraceMeter.d.ets @@ -0,0 +1,308 @@ +/* + * Copyright (C) 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 PerformanceAnalysisKit + */ + +/** + * Provides interfaces to trace a task for performance measure, the logs can be capture by the + * bytrace cmdline available on the device. + * + *

This interfaces trace the start, end, and value changes of key processes that last for at least 3 ms. + * + *

Example: + * Track the beginning of a context: + *

{@code
+ * hiTraceMeter.startTrace("checkName", 111);
+ * }
+ * Track the end of a context: + *
{@code
+ * hiTraceMeter.finishTrace("checkName", 111);
+ * }
+ * To trace the number of layers, which is 3: + *
{@code
+ * hiTraceMeter.traceByValue("curLayer", 3);
+ * }
+ * + *

Each {@code startTrace} matches one {@code finishTrace}, and they must have the same name + * and taskId. + * + * @namespace hiTraceMeter + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ +/** + * Provides interfaces to trace a task for performance measure, the logs can be capture by the + * hitrace cmdline on the device. + * + *

This interfaces trace the start, end, and value changes of key processes that last for at least 3 ms. + * + *

Example: + * Track the beginning of a context: + *

{@code
+ * hiTraceMeter.startAsyncTrace(hiTraceMeter.HiTraceOutputLevel.COMMERCIAL, "checkName", 111, "test", "key=value");
+ * }
+ * Track the end of a context: + *
{@code
+ * hiTraceMeter.finishAsyncTrace(hiTraceMeter.HiTraceOutputLevel.COMMERCIAL, "checkName", 111);
+ * }
+ * To trace the number of layers, which is 3: + *
{@code
+ * hiTraceMeter.traceByValue(hiTraceMeter.HiTraceOutputLevel.COMMERCIAL, "curLayer", 3);
+ * }
+ * + *

Each {@code startTrace} matches one {@code finishTrace}, and they must have the same name + * and taskId. + * + *

Each {@code startSyncTrace} matches one {@code finishSyncTrace}, and they must have the same + * level and name. + * + *

Each {@code startAsyncTrace} matches one {@code finishAsyncTrace}, and they must have the same + * level, name and taskId. + * + * @namespace hiTraceMeter + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ +declare namespace hiTraceMeter { + + /** + * Enumerates the HiTrace output levels. The output level threshold system parameter determines + * the minimum output trace. + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export enum HiTraceOutputLevel { + /** + * Ouput level only for debug usage. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + DEBUG = 0, + + /** + * Output level for log version usage. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + INFO = 1, + + /** + * Output level for log version usage, with higher priority than INFO. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + CRITICAL = 2, + + /** + * Output level for nolog version usage. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + COMMERCIAL = 3, + + /** + * Output level range limit. + * + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + MAX = 3 + } + + /** + * Records a trace marking it as the start of a task, can with the expected completion time between + * startTrace and finishTrace. + * + * This method is invoked at the start of a transaction to indicate that a task has started, whose name + * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by + * {@link #finishTrace}, the name and taskId need to be the same. + * + * @param { string } name Indicates the task name. + * @param { number } taskId The unique id used to distinguish the tasks and match with the id in follow finishTrace. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + /** + * Records a trace marking it as the start of a task, can with the expected completion time between + * startTrace and finishTrace. + * + * This method is invoked at the start of a transaction to indicate that a task has started, whose name + * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by + * {@link #finishTrace}, the name and taskId need to be the same. + * + * @param { string } name Indicates the task name. + * @param { number } taskId The unique id used to distinguish the tasks and match with the id in follow finishTrace. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function startTrace(name: string, taskId: number): void; + + /** + * Records a trace and marks it as the end of a task. + * + * This method is invoked at the end of a transaction to indicate that a task has ended, whose name + * is specified by {@code name}. This method must be invoked after the the startTrace. + * + * @param { string } name Indicates the task name. It must be the same with the {@code name} of startTrace. + * @param { number } taskId The unique id used to distinguish the tasks and must be the same with the . + * {@code taskId} of startTrace. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + /** + * Records a trace and marks it as the end of a task. + * + * This method is invoked at the end of a transaction to indicate that a task has ended, whose name + * is specified by {@code name}. This method must be invoked after {@link #startTrace}. + * + * @param { string } name Indicates the task name. It must be the same with the {@code name} of startTrace. + * @param { number } taskId The unique id used to distinguish the tasks and must be the same with the + * {@code taskId} of startTrace. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function finishTrace(name: string, taskId: number): void; + + /** + * Records a trace for generating a count, such as clock pulse and the number of layers. + * + * @param { string } name Indicates the name used to identify the count. + * @param { number } count Indicates the number of the count. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @since 8 + */ + /** + * Records a trace for generating a count, such as clock pulse and the number of layers. + * + * @param { string } name Indicates the name used to identify the count. + * @param { number } count Indicates the number of the count. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function traceByValue(name: string, count: number): void; + + /** + * Records a trace marking it as the start of a task. + * + * This method is invoked at the start of a transaction to indicate that a task has started, whose name + * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by + * {@link #finishSyncTrace}, called by the same thread with the same level. + * + * @param { HiTraceOutputLevel } level Indicates trace output priority level. + * @param { string } name Indicates the task name. + * @param { string } customArgs Indicates key=value pair to be output in trace; multiple pairs should use comma + * as separator. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function startSyncTrace(level: HiTraceOutputLevel, name: string, customArgs?: string): void; + + /** + * Records a trace and marks it as the end of a task. + * + * This method is invoked at the end of a transaction to indicate that the nearest running task tracked by + * startSyncTrace that has yet to be marked by finishSyncTrace, has ended. + * This method must be invoked after {@link #startSyncTrace}, called by the same thread with the same level. + * + * @param { HiTraceOutputLevel } level Indicates trace output priority level. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function finishSyncTrace(level: HiTraceOutputLevel): void; + + /** + * Records a trace marking it as the start of a task. + * + * This method is invoked at the start of a transaction to indicate that a task has started, whose name + * is specified by {@code name}, and the taskId is used to distinguish the tasks. It must be followed by a + * corresponding {@link #finishAsyncTrace}, with the same level, name, and taskId. + * + * @param { HiTraceOutputLevel } level Indicates trace output priority level. + * @param { string } name Indicates the task name. + * @param { number } taskId The unique id used to distinguish the task and match with the id of the + * corresponding finishAsyncTrace. + * @param { string } customCategory Indicates the label to aggregate asynchronous task display. + * @param { string } customArgs Indicates key=value pair to be output in trace; multiple pairs should use comma + * as Separator. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function startAsyncTrace(level: HiTraceOutputLevel, name: string, taskId: number, customCategory: string, + customArgs?: string): void; + + /** + * Records a trace and marks it as the end of a task. + * + * This method is invoked at the end of a transaction to indicate that a task has ended, whose name is specified + * by {@code name}. This method must be invoked after {@link #startAsyncTrace}, with the same level, name, + * and taskId. It is not required to be invoked by the same thread calling startAsyncTrace. + * + * @param { HiTraceOutputLevel } level Indicates trace output priority level. + * @param { string } name Indicates the task name. + * @param { number } taskId The unique id used to distinguish the task and match with the id of the corresponding + * startAsyncTrace. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function finishAsyncTrace(level: HiTraceOutputLevel, name: string, taskId: number): void; + + /** + * Records a trace for generating a count, such as clock pulse and the number of layers. + * + * @param { HiTraceOutputLevel } level Indicates trace output priority level. + * @param { string } name Indicates the name used to identify the count. + * @param { number } count Indicates the number of the count. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function traceByValue(level: HiTraceOutputLevel, name: string, count: number): void; + + /** + * Return whether the current process is allowed to output trace. + * + * @returns { boolean } The status of whether the current process is allowed to output trace. + * @syscap SystemCapability.HiviewDFX.HiTrace + * @atomicservice + * @since 19 + */ + export function isTraceEnabled(): boolean; + +} + +export default hiTraceMeter; \ No newline at end of file diff --git a/api/@ohos.hichecker.d.ets b/api/@ohos.hichecker.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..cd96d7e8c0440948112bfa42562d525147980c3c --- /dev/null +++ b/api/@ohos.hichecker.d.ets @@ -0,0 +1,157 @@ +/* + * 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 PerformanceAnalysisKit + */ + +/** + * This module provides the capability to check bad code usage. + * + * @namespace hichecker + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + */ +declare namespace hichecker { + /** + * The caution rule print log. + * + * @constant + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + */ + const RULE_CAUTION_PRINT_LOG: bigint = 9223372036854775808n; // 1 << 63 + + /** + * The caution rule trigger crash. + * + * @constant + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + */ + const RULE_CAUTION_TRIGGER_CRASH: bigint = 4611686018427387904n; // 1 << 62 + + /** + * The thread rule check slow process. + * + * @constant + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + */ + const RULE_THREAD_CHECK_SLOW_PROCESS: bigint = 1n; + + /** + * The process rule check slow event. + * + * @constant + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 20 + */ + const RULE_CHECK_SLOW_EVENT: bigint = 4294967296n; // 1 << 32 + + /** + * The process rule check ability connection leak. + * + * @constant + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + */ + const RULE_CHECK_ABILITY_CONNECTION_LEAK: bigint = 8589934592n; // 1 << 33 + + /** + * The process rule check ability Arkui performance + * + * @constant + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 11 + */ + const RULE_CHECK_ARKUI_PERFORMANCE: bigint = 17179869184n; // 1 << 34 + + /** + * add one or more rule. + * + * @param { bigint } rule + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + * @deprecated since 9 + * @useinstead ohos.hichecker/hichecker#addCheckRule + */ + function addRule(rule: bigint): void; + + /** + * remove one or more rule. + * + * @param { bigint } rule + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + * @deprecated since 9 + * @useinstead ohos.hichecker/hichecker#removeCheckRule + */ + function removeRule(rule: bigint): void; + + /** + * get added rule + * + * @returns { bigint } all added thread rule and process rule. + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + */ + function getRule(): bigint; + + /** + * whether the query rule is added + * + * @param { bigint } rule + * @returns { boolean } the result of whether the query rule is added. + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 8 + * @deprecated since 9 + * @useinstead ohos.hichecker/hichecker#containsCheckRule + */ + function contains(rule: bigint): boolean; + + /** + * Add one or more rule. + * + * @param { bigint } rule + * @throws { BusinessError } 401 - the parameter check failed, only one bigint type parameter is needed + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 9 + */ + function addCheckRule(rule: bigint): void; + + /** + * Remove one or more rule. + * + * @param { bigint } rule + * @throws { BusinessError } 401 - the parameter check failed, only one bigint type parameter is needed + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 9 + */ + function removeCheckRule(rule: bigint): void; + + /** + * Whether the query rule is added + * + * @param { bigint } rule + * @returns { boolean } the result of whether the query rule is added. + * @throws { BusinessError } 401 - the parameter check failed, only one bigint type parameter is needed + * @syscap SystemCapability.HiviewDFX.HiChecker + * @since 9 + */ + function containsCheckRule(rule: bigint): boolean; +} +export default hichecker; diff --git a/api/@ohos.hidebug.d.ets b/api/@ohos.hidebug.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..543c7ded1e9d2cc49478b343124b62bfab605110 --- /dev/null +++ b/api/@ohos.hidebug.d.ets @@ -0,0 +1,601 @@ +/* +* Copyright (C) 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 PerformanceAnalysisKit + */ + +/** + * Provide interfaces related to debugger access and obtaining CPU, + * memory and other virtual machine information during runtime for JS programs + * + * @namespace hidebug + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + +/** + * Provide interfaces related to debugger access and obtaining CPU, + * memory and other virtual machine information during runtime for JS programs + * + * @namespace hidebug + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @atomicservice + * @since 20 + */ + +declare namespace hidebug { + /** + * Get total native heap memory size + * + * @returns { bigint } Returns total native heap memory size. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getNativeHeapSize(): bigint; + + /** + * Get Native heap memory allocation size. + * @returns { bigint } Returns native heap memory allocation size. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getNativeHeapAllocatedSize(): bigint; + + /** + * Get Native heap memory free size + * + * @returns { bigint } Returns native heap memory free size. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getNativeHeapFreeSize(): bigint; + + /** + * Get the virtual set size memory of the application process + * + * @returns { bigint } Returns application process virtual set size memory information. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getVss(): bigint; + + /** + * Get application process proportional set size memory information + * + * @returns { bigint } Returns application process proportional set size memory information. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getPss(): bigint; + + /** + * Obtains the size of the shared dirty memory of a process. + * + * @returns { bigint } Returns the size of the shared dirty memory. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getSharedDirty(): bigint; + + /** + * Obtains the size of the private dirty memory of a process. + * @returns { bigint } Returns the size of the private dirty memory. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getPrivateDirty(): bigint; + + /** + * Obtains the cpu usage percent of a process. + * + * @returns { number } Returns the cpu usage of a process. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getCpuUsage(): number; + + /** + * Get a debugging dump of a system service by service id. + * It need dump permission. + * This API can be called only by system application. + * + * @permission ohos.permission.DUMP + * @param { number } serviceid - Indicates the id of the service ability. + * @param { number } fd - The file descriptor. + * @param { Array } args - The args list of the system ability dump interface. + * @throws {BusinessError} 401 - the parameter check failed, Possible causes: + * 1.the parameter type error + * 2.the args parameter is not string array + * @throws {BusinessError} 11400101 - ServiceId invalid. The system ability does not exist. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getServiceDump(serviceid: number, fd: number, args: Array): void; + + /** + * Obtains the cpu usage of system. + * + * @returns { number } Returns the cpu usage of system. + * @throws { BusinessError } 11400104 - The status of the system CPU usage is abnormal. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getSystemCpuUsage(): number; + + /** + * Application CPU usage of thread. + * + * @interface ThreadCpuUsage + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export interface ThreadCpuUsage { + /** + * Thread id + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 12 + */ + threadId: number; + /** + * Cpu usage of thread + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 12 + */ + cpuUsage: number; + } + + /** + * Get the CPU usage of all threads in the application. + * + * @returns { ThreadCpuUsage[] } Returns the CPU usage of all threads in the application. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getAppThreadCpuUsage(): ThreadCpuUsage[]; + + /** + * System memory information + * + * @interface SystemMemInfo + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export interface SystemMemInfo { + /** + * Total system memory size, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + totalMem: bigint; + /** + * System free memory size, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + freeMem: bigint; + /** + * System available memory size, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + availableMem: bigint; + } + + /** + * Obtains the system memory size. + * + * @returns { SystemMemInfo } Returns system memory size. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getSystemMemInfo(): SystemMemInfo; + + /** + * Application process native memory information. + * + * @interface NativeMemInfo + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export interface NativeMemInfo { + /** + * Process proportional set size memory, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + pss: bigint; + /** + * Virtual set size memory, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + vss: bigint; + /** + * Resident set size, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + rss: bigint; + /** + * The size of the shared dirty memory, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + sharedDirty: bigint; + /** + * The size of the private dirty memory, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + privateDirty: bigint; + /** + * The size of the shared clean memory, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + sharedClean: bigint; + /** + * The size of the private clean memory, in kilobyte + * + * @type { bigint } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + privateClean: bigint; + } + + /** + * Obtains the memory information of application process. + * + * @returns { NativeMemInfo } Returns the native memory of a process. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function getAppNativeMemInfo(): NativeMemInfo; + + /** + * Enum for trace flag + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export enum TraceFlag { + /** + * Only capture main thread trace + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + MAIN_THREAD = 1, + /** + * Capture all thread trace + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + ALL_THREADS = 2 + } + + /** + * Provide trace tags + * + * @namespace tags + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export namespace tags { + /** + * Ability Manager tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const ABILITY_MANAGER: number; + /** + * ARKUI development framework tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const ARKUI: number; + /** + * ARK tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const ARK: number; + /** + * Bluetooth tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const BLUETOOTH: number; + /** + * Common library subsystem tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const COMMON_LIBRARY: number; + /** + * Distributed hardware device manager tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_HARDWARE_DEVICE_MANAGER: number; + /** + * Distributed audio tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_AUDIO: number; + /** + * Distributed camera tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_CAMERA: number; + /** + * Distributed data manager module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_DATA: number; + /** + * Distributed hardware framework tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_HARDWARE_FRAMEWORK: number; + /** + * Distributed input tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_INPUT: number; + /** + * Distributed screen tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_SCREEN: number; + /** + * Distributed scheduler tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const DISTRIBUTED_SCHEDULER: number; + /** + * FFRT tasks. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const FFRT: number; + /** + * File management tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const FILE_MANAGEMENT: number; + /** + * Global resource manager tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const GLOBAL_RESOURCE_MANAGER: number; + /** + * Graphics module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const GRAPHICS: number; + /** + * HDF subsystem tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const HDF: number; + /** + * MISC module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const MISC: number; + /** + * Multimodal input module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const MULTIMODAL_INPUT: number; + /** + * Net tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const NET: number; + /** + * Notification module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const NOTIFICATION: number; + /** + * NWeb tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const NWEB: number; + /** + * OHOS generic tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const OHOS: number; + /** + * Power manager tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const POWER_MANAGER: number; + /** + * RPC tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const RPC: number; + /** + * SA tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const SAMGR: number; + /** + * Window manager tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const WINDOW_MANAGER: number; + /** + * Audio module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const AUDIO: number; + /** + * Camera module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const CAMERA: number; + /** + * Image module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const IMAGE: number; + /** + * Media module tag. + * + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + const MEDIA: number; + } + + /** + * Start capture application trace. + * + * @param { number[] } tags - Tag of trace. + * @param { TraceFlag } flag - Trace flag. + * @param { number } limitSize - Max size of trace file, in bytes, the max is 500MB. + * @returns { string } Returns absolute path of the trace file. + * @throws { BusinessError } 401 - Invalid argument, Possible causes: + * 1.The limit parameter is too small + * 2.The parameter is not within the enumeration type + * 3.The parameter type error or parameter order error + * @throws { BusinessError } 11400102 - Capture trace already enabled. + * @throws { BusinessError } 11400103 - No write permission on the file. + * @throws { BusinessError } 11400104 - Abnormal trace status. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function startAppTraceCapture(tags: number[], flag: TraceFlag, limitSize: number): string; + + /** + * Stop capture application trace. + * + * @throws { BusinessError } 11400104 - The status of the trace is abnormal + * @throws { BusinessError } 11400105 - No capture trace running + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @since 20 + */ + export function stopAppTraceCapture(): void; + + /** + * Get the graphics memory of application + * + * @returns { Promise } Returns the graphics memory of application, in kilobyte. + * @throws { BusinessError } 11400104 - Failed to get the application memory due to a remote exception. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @atomicservice + * @since 20 + */ + export function getGraphicsMemory(): Promise; + + /** + * Get the graphics memory of application + * + * @returns { number } Returns the graphics memory of application, in kilobyte. + * @throws { BusinessError } 11400104 - Failed to get the application memory due to a remote exception. + * @syscap SystemCapability.HiviewDFX.HiProfiler.HiDebug + * @atomicservice + * @since 20 + */ + export function getGraphicsMemorySync(): number; +} +export default hidebug; diff --git a/api/@ohos.hilog.d.ets b/api/@ohos.hilog.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..5d72df5cb67f32365ae2f9c2fdbc5329f09d9934 --- /dev/null +++ b/api/@ohos.hilog.d.ets @@ -0,0 +1,414 @@ +/* + * Copyright (c) 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 PerformanceAnalysisKit + */ + +/** +* Provides interfaces to generate system logs. +* +* @namespace hilog +* @syscap SystemCapability.HiviewDFX.HiLog +* @since 7 +*/ +/** +* Provides interfaces to generate system logs. +* +* @namespace hilog +* @syscap SystemCapability.HiviewDFX.HiLog +* @crossplatform +* @since 10 +*/ +/** +* Provides interfaces to generate system logs. +* +* @namespace hilog +* @syscap SystemCapability.HiviewDFX.HiLog +* @crossplatform +* @atomicservice +* @since 11 +*/ +declare namespace hilog { + + /** + * Outputs debug-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Outputs debug-level logs. + * + * * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * Outputs debug-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + export function debug(domain: number, tag: string, format: string, + ...args: (int | boolean | number | string | bigint | Object | undefined | null)[]): void; + + /** + * Outputs info-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Outputs info-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * Outputs info-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + export function info(domain: number, tag: string, format: string, + ...args: (int | boolean | number | string | bigint | Object | undefined | null)[]): void; + + /** + * Outputs warning-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Outputs warning-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * Outputs warning-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + export function warn(domain: number, tag: string, format: string, + ...args: (int | boolean | number | string | bigint | Object | undefined | null)[]): void; + + /** + * Outputs error-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Outputs error-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * Outputs error-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + export function error(domain: number, tag: string, format: string, + ...args: (int | boolean | number | string | bigint | Object | undefined | null)[]): void; + + /** + * Outputs fatal-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Outputs fatal-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * Outputs fatal-level logs. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { string } format Indicates the log format string. + * @param { any[] }args Indicates the log parameters. + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + export function fatal(domain: number, tag: string, format: string, + ...args: (int | boolean | number | string | bigint | Object | undefined | null)[]): void; + + /** + * Checks whether logs of the specified tag, and level can be printed. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { LogLevel } level log level + * @returns { boolean } + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Checks whether logs of the specified tag, and level can be printed. + * + * @param { number } domain Indicates the service domain, which is a hexadecimal integer ranging from 0x0 to 0xFFFF + * if the value exceeds the range, logs cannot be printed. + * @param { string } tag Identifies the log tag, length cannot exceed 32 bytes, the excess part will be truncated. + * @param { LogLevel } level log level + * @returns { boolean } + * @syscap SystemCapability.HiviewDFX.HiLog + * @atomicservice + * @since 11 + */ + export function isLoggable(domain: number, tag: string, level: LogLevel): boolean; + + /** + * Sets the lowest log level of the current application process. + * + * @param { LogLevel } level log level + * @syscap SystemCapability.HiviewDFX.HiLog + * @atomicservice + * @since 15 + */ + export function setMinLogLevel(level: LogLevel): void; + + /** + * Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * Log level define + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * Log level define + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + export enum LogLevel { + /** + * DEBUG Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * DEBUG Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * DEBUG Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + DEBUG = 3, + /** + * INFO Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * INFO Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * INFO Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + INFO = 4, + /** + * WARN Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * WARN Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * WARN Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + WARN = 5, + /** + * ERROR Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * ERROR Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * ERROR Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + ERROR = 6, + /** + * FATAL Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @since 7 + */ + /** + * FATAL Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @since 10 + */ + /** + * FATAL Log level define + * + * @syscap SystemCapability.HiviewDFX.HiLog + * @crossplatform + * @atomicservice + * @since 11 + */ + FATAL = 7 + } +} + +export default hilog; diff --git a/api/@ohos.hiviewdfx.hiAppEvent.d.ets b/api/@ohos.hiviewdfx.hiAppEvent.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..c990aed6812cac7b8ab9d4374d8731191c51f7fc --- /dev/null +++ b/api/@ohos.hiviewdfx.hiAppEvent.d.ets @@ -0,0 +1,1395 @@ +/* + * Copyright (c) 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 PerformanceAnalysisKit + */ + +import { AsyncCallback } from '@ohos.base'; + +/** + * Provides the event logging function for applications to log the fault, statistical, security, + * and user behavior events reported during running. Based on event information, + * you will be able to analyze the running status of applications. + * + * @namespace hiAppEvent + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ +/** + * Provides the event logging function for applications to log the fault, statistical, security, + * and user behavior events reported during running. Based on event information, + * you will be able to analyze the running status of applications. + * + * @namespace hiAppEvent + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ +declare namespace hiAppEvent { + /** + * Enumerate application event types. + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Enumerate application event types. + * + * @enum { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export enum EventType { + /** + * Fault event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Fault event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + FAULT = 1, + + /** + * Statistic event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Statistic event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + STATISTIC = 2, + + /** + * Security event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Security event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + SECURITY = 3, + + /** + * User behavior event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * User behavior event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + BEHAVIOR = 4 + } + + /** + * Preset domain. + * + * @namespace domain + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export namespace domain { + /** + * the domain of operating system. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const OS: string; + } + + /** + * Preset event. + * + * @namespace event + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Preset event. + * + * @namespace event + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 11 + */ + export namespace event { + /** + * User login event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * User login event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const USER_LOGIN: string; + + /** + * User logout event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * User logout event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const USER_LOGOUT: string; + + /** + * Distributed service event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Distributed service event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const DISTRIBUTED_SERVICE_START: string; + + /** + * crash event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const APP_CRASH: string; + + /** + * freeze event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const APP_FREEZE: string; + + /** + * launch event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const APP_LAUNCH: string; + + /** + * scroll jank event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const SCROLL_JANK: string; + + /** + * cpu usage high event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const CPU_USAGE_HIGH: string; + + /** + * battery usage event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const BATTERY_USAGE: string; + + /** + * resource overlimit event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const RESOURCE_OVERLIMIT: string; + + /** + * address sanitizer event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const ADDRESS_SANITIZER: string; + + /** + * main thread jank event. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const MAIN_THREAD_JANK: string; + } + + /** + * Preset param. + * + * @namespace param + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Preset param. + * + * @namespace param + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export namespace param { + /** + * User id. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * User id. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const USER_ID: string; + + /** + * Distributed service name. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Distributed service name. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const DISTRIBUTED_SERVICE_NAME: string; + + /** + * Distributed service instance id. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Distributed service instance id. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + const DISTRIBUTED_SERVICE_INSTANCE_ID: string; + } + + /** + * Application event logging configuration interface. + * + * @param { ConfigOption } config Application event logging configuration item object. + * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 11103001 - Invalid max storage quota value. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Application event logging configuration interface. + * + * @param { ConfigOption } config Application event logging configuration item object. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11103001 - Invalid max storage quota value. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function configure(config: ConfigOption): void; + + /** + * Describe the options for the configuration. + * + * @interface ConfigOption + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Describe the options for the configuration. + * + * @interface ConfigOption + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface ConfigOption { + /** + * Configuration item: application event logging switch. + * + * @type { ?boolean } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Configuration item: application event logging switch. + * + * @type { ?boolean } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + disable?: boolean; + + /** + * Configuration item: event file directory storage quota size. + * + * @type { ?string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Configuration item: event file directory storage quota size. + * + * @type { ?string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + maxStorage?: string; + } + + /** + * Definition of written application event information. + * + * @interface AppEventInfo + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Definition of written application event information. + * + * @interface AppEventInfo + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface AppEventInfo { + /** + * The domain of the event. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The domain of the event. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + domain: string; + + /** + * The name of the event. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The name of the event. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + name: string; + + /** + * The type of the event. + * + * @type { EventType } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The type of the event. + * + * @type { EventType } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + eventType: EventType; + + /** + * The params of the event. + * + * @type { Record } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The params of the event. + * + * @type { Record } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + params: Record; + } + + /** + * Write application event. + * + * @param { AppEventInfo } info Application event information to be written. + * @returns { Promise } Return Promise. + * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 11100001 - Function disabled. + * @throws { BusinessError } 11101001 - Invalid event domain. + * @throws { BusinessError } 11101002 - Invalid event name. + * @throws { BusinessError } 11101003 - Invalid number of event parameters. + * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. + * @throws { BusinessError } 11101005 - Invalid event parameter name. + * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Write application event. + * + * @param { AppEventInfo } info Application event information to be written. + * @returns { Promise } Return Promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11100001 - Function disabled. + * @throws { BusinessError } 11101001 - Invalid event domain. + * @throws { BusinessError } 11101002 - Invalid event name. + * @throws { BusinessError } 11101003 - Invalid number of event parameters. + * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. + * @throws { BusinessError } 11101005 - Invalid event parameter name. + * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function write(info: AppEventInfo): Promise; + + /** + * Write application event. + * + * @param { AppEventInfo } info Application event information to be written. + * @param { AsyncCallback } callback Callback function. + * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 11100001 - Function disabled. + * @throws { BusinessError } 11101001 - Invalid event domain. + * @throws { BusinessError } 11101002 - Invalid event name. + * @throws { BusinessError } 11101003 - Invalid number of event parameters. + * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. + * @throws { BusinessError } 11101005 - Invalid event parameter name. + * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Write application event. + * + * @param { AppEventInfo } info Application event information to be written. + * @param { AsyncCallback } callback Callback function. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11100001 - Function disabled. + * @throws { BusinessError } 11101001 - Invalid event domain. + * @throws { BusinessError } 11101002 - Invalid event name. + * @throws { BusinessError } 11101003 - Invalid number of event parameters. + * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. + * @throws { BusinessError } 11101005 - Invalid event parameter name. + * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function write(info: AppEventInfo, callback: AsyncCallback): void; + + /** + * Indicates possible parameter types. + * + * @typedef {number | string | boolean | Array} + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + type ParamType = number | string | boolean | Array; + + /** + * It is used to set custom parameters for events, including both system-subscribed events and custom events. + * Existing parameter will be overwritten, and non-existing parameter will be created. + * + * @param { Record } params The parameters of the event. + * @param { string } domain The domain of the event. + * @param { string } name The name of the event. + * @returns { Promise } Return Promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11101007 - The number of parameter keys exceeds the limit. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function setEventParam(params: Record, domain: string, name?: string): Promise; + + /** + * Set the config for the os event. + * + * @param { string } name The name of the os event. + * @param { Record } config The config info of the os event. + * @returns { Promise } Return Promise. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types; 3.Parameter verification failed. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function setEventConfig(name: string, config: Record): Promise; + + /** + * Definition of the read event package. + * + * @interface AppEventPackage + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Definition of the read event package. + * + * @interface AppEventPackage + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface AppEventPackage { + /** + * The id of the package. + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The id of the package. + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + packageId: number; + + /** + * The number of events contained in the package. + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The number of events contained in the package. + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + row: number; + + /** + * The total size of events contained in the package. + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The total size of events contained in the package. + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + size: number; + + /** + * The events data contained in the package. + * + * @type { string[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The events data contained in the package. + * + * @type { string[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + data: string[]; + + /** + * The event json format data contained in the package. + * + * @type { Array } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + appEventInfos: Array; + } + + /** + * Definition of event holder object, which is used to read the event data monitored by the watcher. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Definition of event holder object, which is used to read the event data monitored by the watcher. + * + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export class AppEventPackageHolder { + /** + * Constructor for AppEventPackageHolder. + * + * @param { string } watcherName Name of the watcher to read. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Constructor for AppEventPackageHolder. + * + * @param { string } watcherName Name of the watcher to read. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + constructor(watcherName: string); + + /** + * Set the threshold size per read. + * + * @param { number } size Threshold size. + * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 11104001 - Invalid size value. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Set the threshold size per read. + * + * @param { number } size Threshold size. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11104001 - Invalid size value. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + setSize(size: number): void; + + /** + * Set the number of rows per read. + * + * @param { number } size Row size. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11104001 - Invalid size value. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + setRow(size: number): void; + + /** + * Read the event data monitored by the watcher. + * + * @returns { AppEventPackage } The read event package. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Read the event data monitored by the watcher. + * + * @returns { AppEventPackage } The read event package. + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + takeNext(): AppEventPackage; + } + + /** + * Definition of the condition for triggering callback when the watcher monitors event data. + * + * @interface TriggerCondition + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Definition of the condition for triggering callback when the watcher monitors event data. + * + * @interface TriggerCondition + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface TriggerCondition { + /** + * The number of write events that trigger callback. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The number of write events that trigger callback. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + row?: number; + + /** + * The size of write events that trigger callback. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The size of write events that trigger callback. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + size?: number; + + /** + * The interval for triggering callback. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The interval for triggering callback. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + timeOut?: number; + } + + /** + * Definition of event filter object, which is used to filter events monitored by the watcher. + * + * @interface AppEventFilter + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Definition of event filter object, which is used to filter events monitored by the watcher. + * + * @interface AppEventFilter + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface AppEventFilter { + /** + * The name of the event domain to be monitored by the watcher. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The name of the event domain to be monitored by the watcher. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + domain: string; + + /** + * The types of the events to be monitored by the watcher. + * + * @type { ?EventType[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The types of the events to be monitored by the watcher. + * + * @type { ?EventType[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + eventTypes?: EventType[]; + + /** + * The names of the events to be monitored by the watcher. + * + * @type { ?string[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + names?: string[]; + } + + /** + * Definition of event group. + * + * @interface AppEventGroup + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface AppEventGroup { + /** + * The name of the event. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + name: string; + + /** + * The event array which is group by the name. + * + * @type { Array } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + appEventInfos: Array; + } + + /** + * Definition of event watcher object, which is used to monitor written event data. + * + * @interface Watcher + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Definition of event watcher object, which is used to monitor written event data. + * + * @interface Watcher + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface Watcher { + /** + * The name of watcher. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The name of watcher. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + name: string; + + /** + * The condition for triggering callback. + * + * @type { ?TriggerCondition } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The condition for triggering callback. + * + * @type { ?TriggerCondition } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + triggerCondition?: TriggerCondition; + + /** + * The event filters for monitoring events. + * + * @type { ?AppEventFilter[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The event filters for monitoring events. + * + * @type { ?AppEventFilter[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + appEventFilters?: AppEventFilter[]; + + /** + * The callback function of watcher. + * + * @type { ?function } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * The callback function of watcher. + * + * @type { ?function } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + onTrigger?: (curRow: number, curSize: number, holder: AppEventPackageHolder) => void; + + /** + * The callback function, when watcher receive the event. + * + * @type { ?function } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + onReceive?: (domain: string, appEventGroups: Array) => void; + } + + /** + * Add event watcher. + * + * @param { Watcher } watcher Watcher object for monitoring events. + * @returns { AppEventPackageHolder } Holder object, which is used to read the monitoring data of the watcher. + * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 11102001 - Invalid watcher name. + * @throws { BusinessError } 11102002 - Invalid filtering event domain. + * @throws { BusinessError } 11102003 - Invalid row value. + * @throws { BusinessError } 11102004 - Invalid size value. + * @throws { BusinessError } 11102005 - Invalid timeout value. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Add event watcher. + * + * @param { Watcher } watcher Watcher object for monitoring events. + * @returns { AppEventPackageHolder } Holder object, which is used to read the monitoring data of the watcher. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11102001 - Invalid watcher name. + * @throws { BusinessError } 11102002 - Invalid filtering event domain. + * @throws { BusinessError } 11102003 - Invalid row value. + * @throws { BusinessError } 11102004 - Invalid size value. + * @throws { BusinessError } 11102005 - Invalid timeout value. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function addWatcher(watcher: Watcher): AppEventPackageHolder; + + /** + * Remove event watcher. + * + * @param { Watcher } watcher Watcher object for monitoring events. + * @throws { BusinessError } 401 - Parameter error. + * @throws { BusinessError } 11102001 - Invalid watcher name. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Remove event watcher. + * + * @param { Watcher } watcher Watcher object for monitoring events. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @throws { BusinessError } 11102001 - Invalid watcher name. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function removeWatcher(watcher: Watcher): void; + + /** + * Clear all local logging data of the application. + * + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @since 20 + */ + /** + * Clear all local logging data of the application. + * + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function clearData(): void; + + /** + * Set user ID. + * + * @param { string } name The key of the user ID. + * @param { string } value The value of the user ID. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function setUserId(name: string, value: string): void; + + /** + * Get user ID. + * + * @param { string } name The key of the user ID. + * @returns { string } the user ID value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function getUserId(name: string): string; + + /** + * Set user property. + * + * @param { string } name The key of the user property. + * @param { string } value The value of the user property. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function setUserProperty(name: string, value: string): void; + + /** + * Get user property. + * + * @param { string } name The key of the user property. + * @returns { string } the user property value. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function getUserProperty(name: string): string; + + /** + * Describe the event config to be reported by processor. + * + * @interface AppEventReportConfig + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface AppEventReportConfig { + /** + * The domain of the event. + * + * @type { ?string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + domain?: string; + + /** + * The name of the event. + * + * @type { ?string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + name?: string; + + /** + * The realtime report event. + * + * @type { ?boolean } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + isRealTime?: boolean; + } + + /** + * Definition of the processor. + * + * @interface Processor + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export interface Processor { + /** + * The name of the processor. + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + name: string; + + /** + * The processor enable the developer to debug. + * + * @type { ?boolean } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + debugMode?: boolean; + + /** + * The server location which used for the processor to receive the data, defined by the processor. + * + * @type { ?string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + routeInfo?: string; + + /** + * The app ID is provided by the processor. + * + * @type { ?string } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + appId?: string; + + /** + * The processor report the event when start. + * + * @type { ?boolean } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + onStartReport?: boolean; + + /** + * The processor report the event when the application onBackground. + * + * @type { ?boolean } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + onBackgroundReport?: boolean; + + /** + * The processor report the event according to the period. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + periodReport?: int; + + /** + * The processor report the event according to the batch size. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + batchReport?: int; + + /** + * The user ID names which the processor can report. + * + * @type { ?string[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + userIds?: string[]; + + /** + * The user property names which the processor can report. + * + * @type { ?string[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + userProperties?: string[]; + + /** + * The events which the processor can report. + * + * @type { ?AppEventReportConfig[] } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + eventConfigs?: AppEventReportConfig[]; + + /** + * The processor config id. + * + * @type { ?number } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + configId?: int; + + /** + * The processor set custom config data. + * + * @type { ?Record } + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + customConfigs?: Record; + } + + /** + * Add the processor, who can report the event. + * + * @param { Processor } processor The instance which report the event + * @returns { number } The processor unique ID. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function addProcessor(processor: Processor): number; + + /** + * Remove the processor. + * + * @param { number } id The processor unique ID. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; + *
2. Incorrect parameter types. + * @static + * @syscap SystemCapability.HiviewDFX.HiAppEvent + * @atomicservice + * @since 20 + */ + export function removeProcessor(id: number): void; +} + +export default hiAppEvent; diff --git a/api/@ohos.hiviewdfx.hiAppEvent.d.ts b/api/@ohos.hiviewdfx.hiAppEvent.d.ts index 006f4261490b0a7285c8dff6d46a14837a6bb723..1825109022948f603e5db7912607ed5dd0010e35 100644 --- a/api/@ohos.hiviewdfx.hiAppEvent.d.ts +++ b/api/@ohos.hiviewdfx.hiAppEvent.d.ts @@ -39,17 +39,6 @@ import type { AsyncCallback } from './@ohos.base'; * @atomicservice * @since 11 */ -/** - * Provides the event logging function for applications to log the fault, statistical, security, - * and user behavior events reported during running. Based on event information, - * you will be able to analyze the running status of applications. - * - * @namespace hiAppEvent - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ declare namespace hiAppEvent { /** * Enumerate application event types. @@ -66,15 +55,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Enumerate application event types. - * - * @enum { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ enum EventType { /** * Fault event. @@ -89,14 +69,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Fault event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ FAULT = 1, /** @@ -112,14 +84,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Statistic event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ STATISTIC = 2, /** @@ -135,14 +99,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Security event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ SECURITY = 3, /** @@ -158,14 +114,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * User behavior event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ BEHAVIOR = 4 } @@ -177,15 +125,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Preset domain. - * - * @namespace domain - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ namespace domain { /** * the domain of operating system. @@ -194,14 +133,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * the domain of operating system. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const OS: string; } @@ -220,15 +151,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Preset event. - * - * @namespace event - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ namespace event { /** * User login event. @@ -282,14 +204,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * crash event. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const APP_CRASH: string; /** @@ -380,15 +294,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Preset param. - * - * @namespace param - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ namespace param { /** * User id. @@ -403,14 +308,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * User id. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const USER_ID: string; /** @@ -426,14 +323,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Distributed service name. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const DISTRIBUTED_SERVICE_NAME: string; /** @@ -449,14 +338,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Distributed service instance id. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ const DISTRIBUTED_SERVICE_INSTANCE_ID: string; } @@ -482,19 +363,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Application event logging configuration interface. - * - * @param { ConfigOption } config Application event logging configuration item object. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11103001 - Invalid max storage quota value. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function configure(config: ConfigOption): void; /** @@ -512,15 +380,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Describe the options for the configuration. - * - * @interface ConfigOption - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface ConfigOption { /** * Configuration item: application event logging switch. @@ -537,15 +396,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Configuration item: application event logging switch. - * - * @type { ?boolean } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ disable?: boolean; /** @@ -581,15 +431,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of written application event information. - * - * @interface AppEventInfo - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventInfo { /** * The domain of the event. @@ -606,15 +447,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The domain of the event. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ domain: string; /** @@ -632,15 +464,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of the event. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ name: string; /** @@ -658,15 +481,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The type of the event. - * - * @type { EventType } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ eventType: EventType; /** @@ -684,15 +498,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The params of the event. - * - * @type { object } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ params: object; } @@ -732,26 +537,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Write application event. - * - * @param { AppEventInfo } info Application event information to be written. - * @returns { Promise } Return Promise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11100001 - Function disabled. - * @throws { BusinessError } 11101001 - Invalid event domain. - * @throws { BusinessError } 11101002 - Invalid event name. - * @throws { BusinessError } 11101003 - Invalid number of event parameters. - * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. - * @throws { BusinessError } 11101005 - Invalid event parameter name. - * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function write(info: AppEventInfo): Promise; /** @@ -790,26 +575,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Write application event. - * - * @param { AppEventInfo } info Application event information to be written. - * @param { AsyncCallback } callback Callback function. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11100001 - Function disabled. - * @throws { BusinessError } 11101001 - Invalid event domain. - * @throws { BusinessError } 11101002 - Invalid event name. - * @throws { BusinessError } 11101003 - Invalid number of event parameters. - * @throws { BusinessError } 11101004 - Invalid string length of the event parameter. - * @throws { BusinessError } 11101005 - Invalid event parameter name. - * @throws { BusinessError } 11101006 - Invalid array length of the event parameter. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function write(info: AppEventInfo, callback: AsyncCallback): void; /** @@ -820,15 +585,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * Indicates possible parameter types. - * - * @typedef {number | string | boolean | Array} - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ type ParamType = number | string | boolean | Array; /** @@ -847,23 +603,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * It is used to set custom parameters for events, including both system-subscribed events and custom events. - * Existing parameter will be overwritten, and non-existing parameter will be created. - * - * @param { Record } params The parameters of the event. - * @param { string } domain The domain of the event. - * @param { string } name The name of the event. - * @returns { Promise } Return Promise. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11101007 - The number of parameter keys exceeds the limit. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function setEventParam(params: Record, domain: string, name?: string): Promise; /** @@ -896,15 +635,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of the read event package. - * - * @interface AppEventPackage - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventPackage { /** * The id of the package. @@ -921,15 +651,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The id of the package. - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ packageId: number; /** @@ -947,15 +668,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The number of events contained in the package. - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ row: number; /** @@ -973,15 +685,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The total size of events contained in the package. - * - * @type { number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ size: number; /** @@ -999,15 +702,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The events data contained in the package. - * - * @type { string[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ data: string[]; /** @@ -1018,15 +712,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * The event json format data contained in the package. - * - * @type { Array } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ appEventInfos: Array; } @@ -1043,14 +728,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event holder object, which is used to read the event data monitored by the watcher. - * - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ class AppEventPackageHolder { /** * Constructor for AppEventPackageHolder. @@ -1067,15 +744,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Constructor for AppEventPackageHolder. - * - * @param { string } watcherName Name of the watcher to read. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ constructor(watcherName: string); /** @@ -1098,18 +766,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Set the threshold size per read. - * - * @param { number } size Threshold size. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11104001 - Invalid size value. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ setSize(size: number): void; /** @@ -1123,18 +779,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 12 */ - /** - * Set the number of rows per read. - * - * @param { number } size Row size. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11104001 - Invalid size value. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ setRow(size: number): void; /** @@ -1152,15 +796,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Read the event data monitored by the watcher. - * - * @returns { AppEventPackage } The read event package. - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ takeNext(): AppEventPackage; } @@ -1179,15 +814,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of the condition for triggering callback when the watcher monitors event data. - * - * @interface TriggerCondition - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface TriggerCondition { /** * The number of write events that trigger callback. @@ -1204,15 +830,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The number of write events that trigger callback. - * - * @type { ?number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ row?: number; /** @@ -1230,15 +847,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The size of write events that trigger callback. - * - * @type { ?number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ size?: number; /** @@ -1256,15 +864,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The interval for triggering callback. - * - * @type { ?number } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ timeOut?: number; } @@ -1283,15 +882,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event filter object, which is used to filter events monitored by the watcher. - * - * @interface AppEventFilter - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventFilter { /** * The name of the event domain to be monitored by the watcher. @@ -1308,15 +898,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of the event domain to be monitored by the watcher. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ domain: string; /** @@ -1334,15 +915,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The types of the events to be monitored by the watcher. - * - * @type { ?EventType[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ eventTypes?: EventType[]; /** @@ -1353,15 +925,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The names of the events to be monitored by the watcher. - * - * @type { ?string[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ names?: string[]; } @@ -1373,15 +936,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event group. - * - * @interface AppEventGroup - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface AppEventGroup { /** * The name of the event. @@ -1391,15 +945,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of the event. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ name: string; /** @@ -1410,15 +955,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The event array which is group by the name. - * - * @type { Array } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ appEventInfos: Array; } @@ -1437,15 +973,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Definition of event watcher object, which is used to monitor written event data. - * - * @interface Watcher - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ interface Watcher { /** * The name of watcher. @@ -1462,15 +989,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The name of watcher. - * - * @type { string } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ name: string; /** @@ -1488,15 +1006,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The condition for triggering callback. - * - * @type { ?TriggerCondition } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ triggerCondition?: TriggerCondition; /** @@ -1514,15 +1023,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The event filters for monitoring events. - * - * @type { ?AppEventFilter[] } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ appEventFilters?: AppEventFilter[]; /** @@ -1540,15 +1040,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The callback function of watcher. - * - * @type { ?function } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ onTrigger?: (curRow: number, curSize: number, holder: AppEventPackageHolder) => void; /** @@ -1559,15 +1050,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * The callback function, when watcher receive the event. - * - * @type { ?function } - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ onReceive?: (domain: string, appEventGroups: Array) => void; } @@ -1603,24 +1085,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Add event watcher. - * - * @param { Watcher } watcher Watcher object for monitoring events. - * @returns { AppEventPackageHolder } Holder object, which is used to read the monitoring data of the watcher. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11102001 - Invalid watcher name. - * @throws { BusinessError } 11102002 - Invalid filtering event domain. - * @throws { BusinessError } 11102003 - Invalid row value. - * @throws { BusinessError } 11102004 - Invalid size value. - * @throws { BusinessError } 11102005 - Invalid timeout value. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function addWatcher(watcher: Watcher): AppEventPackageHolder; /** @@ -1645,19 +1109,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Remove event watcher. - * - * @param { Watcher } watcher Watcher object for monitoring events. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @throws { BusinessError } 11102001 - Invalid watcher name. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function removeWatcher(watcher: Watcher): void; /** @@ -1675,15 +1126,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Clear all local logging data of the application. - * - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function clearData(): void; /** @@ -1698,19 +1140,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Set user ID. - * - * @param { string } name The key of the user ID. - * @param { string } value The value of the user ID. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function setUserId(name: string, value: string): void; /** @@ -1725,19 +1154,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Get user ID. - * - * @param { string } name The key of the user ID. - * @returns { string } the user ID value. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function getUserId(name: string): string; /** @@ -1752,19 +1168,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Set user property. - * - * @param { string } name The key of the user property. - * @param { string } value The value of the user property. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function setUserProperty(name: string, value: string): void; /** @@ -1779,19 +1182,6 @@ declare namespace hiAppEvent { * @atomicservice * @since 11 */ - /** - * Get user property. - * - * @param { string } name The key of the user property. - * @returns { string } the user property value. - * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; - *
2. Incorrect parameter types. - * @static - * @syscap SystemCapability.HiviewDFX.HiAppEvent - * @crossplatform - * @atomicservice - * @since 18 - */ function getUserProperty(name: string): string; /** diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts index ed3ec67d2ecef4bb9d42a1374fea7312c2bb9180..bf4e0fbbd4ffc955da85e90c1dedf336362fed25 100644 --- a/api/@ohos.i18n.d.ts +++ b/api/@ohos.i18n.d.ts @@ -18,8 +18,14 @@ * @kit LocalizationKit */ +/*** if arkts 1.1&1.2 */ import { BusinessError } from './@ohos.base'; -import intl from '@ohos.intl'; +import intl from './@ohos.intl'; +/*** endif */ +/*** if arkts 1.2 */ +import { StyledString, TextStyle } from './arkui/component/styledString'; +/*** endif */ + /** * Provides international settings related APIs. @@ -36,7 +42,8 @@ import intl from '@ohos.intl'; * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace i18n { /** @@ -120,7 +127,8 @@ declare namespace i18n { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export class System { /** @@ -160,7 +168,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string; @@ -201,7 +210,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ static getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string; @@ -218,7 +228,8 @@ declare namespace i18n { * @returns { Array } all languages supported by the system. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getSystemLanguages(): Array; @@ -241,7 +252,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getSystemCountries(language: string): Array; @@ -266,7 +278,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static isSuggested(language: string, region?: string): boolean; @@ -293,7 +306,8 @@ declare namespace i18n { * @crossplatform * @form * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ static getSystemLanguage(): string; @@ -307,7 +321,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static setSystemLanguage(language: string): void; @@ -333,7 +348,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getSystemRegion(): string; @@ -347,7 +363,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static setSystemRegion(region: string): void; @@ -373,7 +390,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ static getSystemLocale(): string; @@ -387,7 +405,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static setSystemLocale(locale: string): void; @@ -423,7 +442,8 @@ declare namespace i18n { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static is24HourClock(): boolean; @@ -437,7 +457,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static set24HourClock(option: boolean): void; @@ -452,7 +473,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static addPreferredLanguage(language: string, index?: number): void; @@ -466,7 +488,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static removePreferredLanguage(index: number): void; @@ -483,7 +506,8 @@ declare namespace i18n { * @returns { Array } a string Array represent the preferred language list. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getPreferredLanguageList(): Array; @@ -500,7 +524,8 @@ declare namespace i18n { * @returns { string } a string represent the first preferred language of system. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getFirstPreferredLanguage(): string; @@ -521,7 +546,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static setAppPreferredLanguage(language: string): void; @@ -538,7 +564,8 @@ declare namespace i18n { * @returns { string } a string represent the preferred language of App. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAppPreferredLanguage(): string; @@ -552,7 +579,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ static setUsingLocalDigit(flag: boolean): void; @@ -569,7 +597,8 @@ declare namespace i18n { * @returns { boolean } a boolean represents whether to use local digit. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getUsingLocalDigit(): boolean; @@ -588,7 +617,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ static getSimplifiedLanguage(language?: string): string; @@ -603,7 +633,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static setTemperatureType(type: TemperatureType): void; @@ -613,7 +644,8 @@ declare namespace i18n { * @returns { TemperatureType } temperature type. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getTemperatureType(): TemperatureType; @@ -626,7 +658,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getTemperatureName(type: TemperatureType): string; @@ -641,7 +674,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static setFirstDayOfWeek(type: WeekDay): void; @@ -651,7 +685,8 @@ declare namespace i18n { * @returns { WeekDay } one of week days. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getFirstDayOfWeek(): WeekDay; } @@ -662,7 +697,8 @@ declare namespace i18n { * @enum { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum WeekDay { /** @@ -670,7 +706,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ MON = 1, @@ -679,7 +716,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ TUE = 2, @@ -688,7 +726,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ WED = 3, @@ -697,7 +736,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ THU = 4, @@ -706,7 +746,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ FRI = 5, @@ -715,7 +756,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SAT = 6, @@ -724,7 +766,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SUN = 7 } @@ -735,7 +778,8 @@ declare namespace i18n { * @enum { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum TemperatureType { /** @@ -743,7 +787,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ CELSIUS = 1, @@ -752,7 +797,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ FAHRENHEIT = 2, @@ -761,7 +807,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ KELVIN = 3 } @@ -812,7 +859,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class I18NUtil { /** @@ -838,7 +886,8 @@ declare namespace i18n { * @returns { string } converted number and unit. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string; @@ -870,7 +919,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getDateOrder(locale: string): string; @@ -895,7 +945,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getTimePeriodName(hour:number, locale?: string): string; @@ -912,7 +963,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getBestMatchLocale(locale: string, localeList: string[]): string; @@ -926,7 +978,8 @@ declare namespace i18n { * @static * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getThreeLetterLanguage(locale: string): string; @@ -940,7 +993,8 @@ declare namespace i18n { * @static * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getThreeLetterRegion(locale: string): string; @@ -958,7 +1012,8 @@ declare namespace i18n { * @static * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ static getUnicodeWrappedFilePath(path: string, delimiter?: string, locale?: intl.Locale): string; } @@ -976,7 +1031,8 @@ declare namespace i18n { * @interface UnitInfo * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface UnitInfo { /** @@ -991,7 +1047,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ unit: string; @@ -1007,7 +1064,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ measureSystem: string; } @@ -1034,7 +1092,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface PhoneNumberFormatOptions { /** @@ -1066,7 +1125,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type?: string; } @@ -1090,7 +1150,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class PhoneNumberFormat { /** @@ -1118,7 +1179,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(country: string, options?: PhoneNumberFormatOptions); @@ -1147,7 +1209,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isValidNumber(number: string): boolean; @@ -1176,7 +1239,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ format(number: string): string; @@ -1197,7 +1261,8 @@ declare namespace i18n { * @returns { string } a string represents phone number's location. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getLocationName(number: string, locale: string): string; } @@ -1236,7 +1301,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getCalendar(locale: string, type?: string): Calendar; @@ -1259,7 +1325,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class Calendar { /** @@ -1284,7 +1351,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setTime(date: Date): void; @@ -1310,7 +1378,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setTime(time: number): void; @@ -1351,7 +1420,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ set(year: number, month: number, date: number, hour?: number, minute?: number, second?: number): void; @@ -1377,7 +1447,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setTimeZone(timezone: string): void; @@ -1403,7 +1474,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getTimeZone(): string; @@ -1429,7 +1501,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getFirstDayOfWeek(): number; @@ -1455,7 +1528,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setFirstDayOfWeek(value: number): void; @@ -1481,7 +1555,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getMinimalDaysInFirstWeek(): number; @@ -1507,7 +1582,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setMinimalDaysInFirstWeek(value: number): void; @@ -1542,7 +1618,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ get(field: string): number; @@ -1561,7 +1638,8 @@ declare namespace i18n { * @returns { string } the localized name of this calendar. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getDisplayName(locale: string): string; @@ -1593,7 +1671,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isWeekend(date?: Date): boolean; @@ -1620,7 +1699,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ add(field: string, amount: number): void; @@ -1639,7 +1719,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getTimeInMillis(): number; @@ -1664,7 +1745,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ compareDays(date: Date): number; } @@ -1694,7 +1776,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function isRTL(locale: string): boolean; @@ -1713,7 +1796,8 @@ declare namespace i18n { * @returns { BreakIterator } a newly constructed BreakIterator object. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getLineInstance(locale: string): BreakIterator; @@ -1728,7 +1812,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class BreakIterator { /** @@ -1744,7 +1829,8 @@ declare namespace i18n { * @returns { number } the current position of the BreakIterator instance. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ current(): number; @@ -1763,7 +1849,8 @@ declare namespace i18n { * @returns { number } the index of the first break point. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ first(): number; @@ -1782,7 +1869,8 @@ declare namespace i18n { * @returns { number } the index of the last break point. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ last(): number; @@ -1801,7 +1889,8 @@ declare namespace i18n { * @returns { number } the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ next(index?: number): number; @@ -1818,7 +1907,8 @@ declare namespace i18n { * @returns { number } the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ previous(): number; @@ -1835,7 +1925,8 @@ declare namespace i18n { * @param { string } text - Indicates the text to be processed by the BreakIterator. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ setLineBreakText(text: string): void; @@ -1854,7 +1945,8 @@ declare namespace i18n { * @returns { number } the index of the BreakIterator after moving. If there is not enough break points, returns -1. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ following(offset: number): number; @@ -1871,7 +1963,8 @@ declare namespace i18n { * @returns { string } the text that is processed by the BreakIterator. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getLineBreakText(): string; @@ -1894,7 +1987,8 @@ declare namespace i18n { * @returns { boolean } true if the offset is a break point. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isBoundary(offset: number): boolean; } @@ -1916,7 +2010,8 @@ declare namespace i18n { * @returns { IndexUtil } IndexUtil object. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getInstance(locale?: string): IndexUtil; @@ -1933,7 +2028,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class IndexUtil { /** @@ -1949,7 +2045,8 @@ declare namespace i18n { * @returns { Array } a list of labels * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getIndexList(): Array; @@ -1966,7 +2063,8 @@ declare namespace i18n { * @param { string } locale - The locale whose index characters are to be added. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ addLocale(locale: string): void; @@ -1985,7 +2083,8 @@ declare namespace i18n { * @returns { string } index of the input text * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getIndex(text: string): string; } @@ -2127,22 +2226,25 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class Unicode { /** * Determines whether the specified code point is a digit character * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a digit character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines whether the specified code point is a digit character * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a digit character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2150,28 +2252,32 @@ declare namespace i18n { /** * Determines whether the specified code point is a digit character * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a digit character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isDigit(char: string): boolean; + static isDigit(ch: string): boolean; /** * Determines if the specified character is a space character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a space character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a space character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a space character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2179,28 +2285,32 @@ declare namespace i18n { /** * Determines if the specified character is a space character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a space character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isSpaceChar(char: string): boolean; + static isSpaceChar(ch: string): boolean; /** * Determines if the specified character is a whitespace character * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a whitespace character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a whitespace character * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a whitespace character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2208,28 +2318,32 @@ declare namespace i18n { /** * Determines if the specified character is a whitespace character * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a whitespace character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isWhitespace(char: string): boolean; + static isWhitespace(ch: string): boolean; /** * Determines if the specified character is a RTL character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a RTL character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a RTL character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a RTL character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2237,28 +2351,32 @@ declare namespace i18n { /** * Determines if the specified character is a RTL character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a RTL character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isRTL(char: string): boolean; + static isRTL(ch: string): boolean; /** * Determines if the specified character is a Ideographic character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a Ideographic character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a Ideographic character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a Ideographic character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2266,28 +2384,32 @@ declare namespace i18n { /** * Determines if the specified character is a Ideographic character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a Ideographic character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isIdeograph(char: string): boolean; + static isIdeograph(ch: string): boolean; /** * Determines if the specified character is a Letter or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a Letter + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a Letter or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a Letter + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2295,28 +2417,32 @@ declare namespace i18n { /** * Determines if the specified character is a Letter or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a Letter + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isLetter(char: string): boolean; + static isLetter(ch: string): boolean; /** * Determines if the specified character is a LowerCase character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a LowerCase character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a LowerCase character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a LowerCase character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2324,28 +2450,32 @@ declare namespace i18n { /** * Determines if the specified character is a LowerCase character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a LowerCase character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isLowerCase(char: string): boolean; + static isLowerCase(ch: string): boolean; /** * Determines if the specified character is a UpperCase character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a UpperCase character + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Determines if the specified character is a UpperCase character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a UpperCase character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2353,28 +2483,32 @@ declare namespace i18n { /** * Determines if the specified character is a UpperCase character or not. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { boolean } true if the character is a UpperCase character + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static isUpperCase(char: string): boolean; + static isUpperCase(ch: string): boolean; /** * Get the general category value of the specified character. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { string } the general category of the specified character. + * @static * @syscap SystemCapability.Global.I18n * @since 9 */ /** * Get the general category value of the specified character. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { string } the general category of the specified character. + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @since 10 @@ -2382,14 +2516,16 @@ declare namespace i18n { /** * Get the general category value of the specified character. * - * @param { string } char - the character to be tested + * @param { string } ch - the character to be tested * @returns { string } the general category of the specified character. + * @static * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - static getType(char: string): string; + static getType(ch: string): string; } /** @@ -2490,7 +2626,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getTimeZone(zoneID?: string): TimeZone; @@ -2513,7 +2650,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class TimeZone { /** @@ -2538,7 +2676,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getID(): string; @@ -2559,7 +2698,8 @@ declare namespace i18n { * @returns { string } a string represents the display name. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getDisplayName(locale?: string, isDST?: boolean): string; @@ -2585,7 +2725,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getRawOffset(): number; @@ -2614,7 +2755,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getOffset(date?: number): number; @@ -2640,7 +2782,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAvailableIDs(): Array; @@ -2657,7 +2800,8 @@ declare namespace i18n { * @returns { Array } a string array represents the available Zone City ID list. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAvailableZoneCityIDs(): Array; @@ -2678,7 +2822,8 @@ declare namespace i18n { * @returns { string } a string represents the display name of City in locale. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getCityDisplayName(cityID: string, locale: string): string; @@ -2697,7 +2842,8 @@ declare namespace i18n { * @returns { TimeZone } a TimeZone Object from city ID. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getTimezoneFromCity(cityID: string): TimeZone; @@ -2723,7 +2869,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getTimezonesByLocation(longitude: number, latitude: number): Array; } @@ -2739,7 +2886,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class Transliterator { /** @@ -2755,7 +2903,8 @@ declare namespace i18n { * @returns { string[] } a string array of all available transliterator ids. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getAvailableIDs(): string[]; @@ -2778,7 +2927,8 @@ declare namespace i18n { * @returns { Transliterator } Transliterator that is specified by id name. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getInstance(id: string): Transliterator; @@ -2797,7 +2947,8 @@ declare namespace i18n { * @returns { string } the output text that is transliterated from source format to the dest format. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ transform(text: string): string; } @@ -2815,7 +2966,8 @@ declare namespace i18n { * @enum { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum NormalizerMode { /** @@ -2829,7 +2981,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NFC = 1, /** @@ -2843,7 +2996,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NFD = 2, /** @@ -2857,7 +3011,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NFKC = 3, /** @@ -2871,7 +3026,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NFKD = 4 } @@ -2887,7 +3043,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class Normalizer { /** @@ -2907,7 +3064,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getInstance(mode: NormalizerMode): Normalizer; @@ -2928,7 +3086,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ normalize(text: string): string; } @@ -2939,7 +3098,8 @@ declare namespace i18n { * @enum { number } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum SuggestionType { /** @@ -2947,7 +3107,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SUGGESTION_TYPE_NONE = 0, /** @@ -2955,7 +3116,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SUGGESTION_TYPE_RELATED = 1, /** @@ -2963,7 +3125,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SUGGESTION_TYPE_SIM = 2, } @@ -2974,7 +3137,8 @@ declare namespace i18n { * @interface SortOptions * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface SortOptions { /** @@ -2983,7 +3147,8 @@ declare namespace i18n { * @type { ?string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -2993,7 +3158,8 @@ declare namespace i18n { * @type { ?boolean } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isUseLocalName?: boolean; @@ -3003,7 +3169,8 @@ declare namespace i18n { * @type { ?boolean } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ isSuggestedFirst?: boolean; } @@ -3014,7 +3181,8 @@ declare namespace i18n { * @interface LocaleItem * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface LocaleItem { /** @@ -3023,7 +3191,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ id: string; @@ -3033,7 +3202,8 @@ declare namespace i18n { * @type { SuggestionType } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ suggestionType: SuggestionType; @@ -3043,7 +3213,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ displayName: string; @@ -3052,7 +3223,8 @@ declare namespace i18n { * @type { ?string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ localName?: string; } @@ -3063,7 +3235,8 @@ declare namespace i18n { * @interface TimeZoneCityItem * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface TimeZoneCityItem { /** @@ -3072,7 +3245,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ zoneId: string; @@ -3082,7 +3256,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ cityId: string; @@ -3092,7 +3267,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ cityDisplayName: string; @@ -3101,7 +3277,8 @@ declare namespace i18n { * @type { number } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ offset: number; @@ -3111,7 +3288,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ zoneDisplayName: string; @@ -3120,7 +3298,8 @@ declare namespace i18n { * @type { ?number } * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ rawOffset?: number; } @@ -3130,7 +3309,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export class SystemLocaleManager { /** @@ -3138,7 +3318,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3165,7 +3346,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getLanguageInfoArray(languages: Array, options?: SortOptions): Array; @@ -3192,7 +3374,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getRegionInfoArray(regions: Array, options?: SortOptions): Array; @@ -3211,7 +3394,8 @@ declare namespace i18n { * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. * @syscap SystemCapability.Global.I18n * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ static getTimeZoneCityItemArray(): Array; } @@ -3229,7 +3413,8 @@ declare namespace i18n { * @interface HolidayInfoItem * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface HolidayInfoItem { /** @@ -3245,7 +3430,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ baseName: string; @@ -3262,7 +3448,8 @@ declare namespace i18n { * @type { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ year: number; @@ -3279,7 +3466,8 @@ declare namespace i18n { * @type { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ month: number; @@ -3296,7 +3484,8 @@ declare namespace i18n { * @type { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ day: number; @@ -3313,7 +3502,8 @@ declare namespace i18n { * @type { ?Array } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ localNames?: Array; } @@ -3331,7 +3521,8 @@ declare namespace i18n { * @interface HolidayLocalName * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface HolidayLocalName { /** @@ -3347,7 +3538,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ language: string; @@ -3364,7 +3556,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; } @@ -3380,7 +3573,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class HolidayManager { /** @@ -3400,7 +3594,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(icsPath: String); @@ -3423,7 +3618,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ isHoliday(date?: Date): boolean; @@ -3448,7 +3644,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ getHolidayInfoItemArray(year?: number): Array; } @@ -3466,7 +3663,8 @@ declare namespace i18n { * @interface EntityInfoItem * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface EntityInfoItem { /** @@ -3482,7 +3680,8 @@ declare namespace i18n { * @type { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ begin: number; @@ -3499,7 +3698,8 @@ declare namespace i18n { * @type { number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ end: number; @@ -3516,7 +3716,8 @@ declare namespace i18n { * @type { string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type: string; } @@ -3532,7 +3733,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class EntityRecognizer { /** @@ -3552,7 +3754,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale?: string); @@ -3573,7 +3776,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ findEntityInfo(text: string): Array; } @@ -3589,7 +3793,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getSimpleDateTimeFormatByPattern(pattern: string, locale?: intl.Locale): SimpleDateTimeFormat; @@ -3605,7 +3810,8 @@ declare namespace i18n { * @throws { BusinessError } 890001 - Invalid parameter. Possible causes: Parameter verification failed. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getSimpleDateTimeFormatBySkeleton(skeleton: string, locale?: intl.Locale): SimpleDateTimeFormat; @@ -3614,7 +3820,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export class SimpleDateTimeFormat { /** @@ -3625,7 +3832,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ format(date: Date): string; } @@ -3642,7 +3850,8 @@ declare namespace i18n { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export function getSimpleNumberFormatBySkeleton(skeleton: string, locale?: intl.Locale): SimpleNumberFormat; @@ -3651,7 +3860,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export class SimpleNumberFormat { /** @@ -3662,7 +3872,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ format(value: number): string; } @@ -3672,7 +3883,8 @@ declare namespace i18n { * * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export class StyledNumberFormat { /** @@ -3683,7 +3895,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(numberFormat: intl.NumberFormat | SimpleNumberFormat, options?: StyledNumberFormatOptions); @@ -3695,7 +3908,8 @@ declare namespace i18n { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ format(value: number): StyledString; } @@ -3706,7 +3920,8 @@ declare namespace i18n { * @interface StyledNumberFormatOptions * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface StyledNumberFormatOptions { /** @@ -3715,7 +3930,8 @@ declare namespace i18n { * @type { ?TextStyle } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ integer?: TextStyle; @@ -3725,7 +3941,8 @@ declare namespace i18n { * @type { ?TextStyle } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ decimal?: TextStyle; @@ -3735,7 +3952,8 @@ declare namespace i18n { * @type { ?TextStyle } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ fraction?: TextStyle; @@ -3745,7 +3963,8 @@ declare namespace i18n { * @type { ?TextStyle } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ unit?: TextStyle; } diff --git a/api/@ohos.inputMethod.Panel.d.ts b/api/@ohos.inputMethod.Panel.d.ts index b9c045c9c0d42af5464a6233081c725d6ffa3a21..b216b490585db704022eda789dccedd9b4c37ba0 100644 --- a/api/@ohos.inputMethod.Panel.d.ts +++ b/api/@ohos.inputMethod.Panel.d.ts @@ -23,7 +23,8 @@ * * @typedef PanelInfo * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface PanelInfo { /** @@ -31,7 +32,8 @@ export interface PanelInfo { * * @type { PanelType } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type: PanelType; @@ -42,7 +44,8 @@ export interface PanelInfo { * @type { ?PanelFlag } * @default FLG_FIXED * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ flag?: PanelFlag; } @@ -52,7 +55,8 @@ export interface PanelInfo { * * @enum { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PanelFlag { /** @@ -61,7 +65,8 @@ export enum PanelFlag { * When the flag is set, the soft keyboard is fixed at the bottom of the screen.

* * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_FIXED = 0, @@ -71,7 +76,8 @@ export enum PanelFlag { * When the flag is set, the soft keyboard is floating.

* * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_FLOATING, @@ -83,7 +89,8 @@ export enum PanelFlag { * Input method application developers are supposed to control the panel status on their own.

* * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_CANDIDATE } @@ -93,14 +100,16 @@ export enum PanelFlag { * * @enum { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum PanelType { /** * Panel for displaying a virtual soft keyboard. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ SOFT_KEYBOARD = 0, @@ -108,7 +117,8 @@ export enum PanelType { * Panel for displaying status bar. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ STATUS_BAR } diff --git a/api/@ohos.inputMethod.d.ts b/api/@ohos.inputMethod.d.ts index 1a6650f58d56ff52b624331e2f8c1ccb2a16365c..9edc69070b6b7e31036b2b699a613ce524d38d77 100644 --- a/api/@ohos.inputMethod.d.ts +++ b/api/@ohos.inputMethod.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 Huawei Device Co., Ltd. + * 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 @@ -17,17 +17,24 @@ * @file * @kit IMEKit */ -import type { Callback, AsyncCallback } from './@ohos.base'; -import type { ElementName } from './bundleManager/ElementName'; +import type { Callback, AsyncCallback, /*** if arkts 1.1 */int /*** endif */} from './@ohos.base'; import InputMethodSubtype from './@ohos.InputMethodSubtype'; +/*** if arkts 1.1 */ +import type { ElementName } from './bundleManager/ElementName'; import type { PanelInfo } from './@ohos.inputMethod.Panel'; +/*** endif */ +/*** if arkts 1.2 */ +import { ElementName } from './bundleManager/ElementName'; +import { PanelInfo } from './@ohos.inputMethod.Panel'; +/*** endif */ /** * Input method * * @namespace inputMethod * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 6 + * @since arkts {'1.1':'6', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace inputMethod { /** @@ -66,7 +73,8 @@ declare namespace inputMethod { * @returns { InputMethodSetting } the object of InputMethodSetting. * @throws { BusinessError } 12800007 - setter error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSetting(): InputMethodSetting; @@ -76,7 +84,8 @@ declare namespace inputMethod { * @returns { InputMethodController } the object of InputMethodController. * @throws { BusinessError } 12800006 - input method controller error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getController(): InputMethodController; @@ -86,7 +95,8 @@ declare namespace inputMethod { * @returns { InputMethodProperty } property of the default input method. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultInputMethod(): InputMethodProperty; @@ -96,7 +106,8 @@ declare namespace inputMethod { * @returns { ElementName } the information of system input method config ability. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSystemInputMethodConfigAbility(): ElementName; @@ -124,7 +135,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800005 - configuration persistence error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function switchInputMethod(target: InputMethodProperty, callback: AsyncCallback): void; @@ -152,7 +164,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800005 - configuration persistence error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function switchInputMethod(target: InputMethodProperty): Promise; @@ -161,7 +174,8 @@ declare namespace inputMethod { * * @returns { InputMethodProperty } the property of current inputmethod. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentInputMethod(): InputMethodProperty; @@ -203,7 +217,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800005 - configuration persistence error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function switchCurrentInputMethodSubtype(target: InputMethodSubtype, callback: AsyncCallback): void; @@ -245,7 +260,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800005 - configuration persistence error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function switchCurrentInputMethodSubtype(target: InputMethodSubtype): Promise; @@ -254,7 +270,8 @@ declare namespace inputMethod { * * @returns { InputMethodSubtype } the subtype of the current input method. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getCurrentInputMethodSubtype(): InputMethodSubtype; @@ -341,14 +358,16 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function switchInputMethod(bundleName: string, subtypeId?: string): Promise; /** * @interface InputMethodSetting * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface InputMethodSetting { /** @@ -357,7 +376,8 @@ declare namespace inputMethod { * @param { 'imeChange' } type - Indicates the event type. * @param { function } callback - the callback of 'imeChange' * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ on( type: 'imeChange', @@ -371,7 +391,8 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'imeChange', * when subscriber unsubscribes all callback functions of event 'imeChange', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ off( type: 'imeChange', @@ -386,7 +407,8 @@ declare namespace inputMethod { * @throws { BusinessError } 202 - not system application. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'imeShow', callback: (info: Array) => void): void; @@ -398,7 +420,8 @@ declare namespace inputMethod { * when subscriber unsubscribes all callback functions of event 'imeShow', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'imeShow', callback?: (info: Array) => void): void; @@ -410,7 +433,8 @@ declare namespace inputMethod { * @throws { BusinessError } 202 - not system application. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'imeHide', callback: (info: Array) => void): void; @@ -422,7 +446,8 @@ declare namespace inputMethod { * when subscriber unsubscribes all callback functions of event 'imeHide', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'imeHide', callback?: (info: Array) => void): void; @@ -439,7 +464,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ isPanelShown(panelInfo: PanelInfo): boolean; @@ -453,7 +479,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ listInputMethodSubtype( inputMethodProperty: InputMethodProperty, @@ -470,7 +497,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ listInputMethodSubtype(inputMethodProperty: InputMethodProperty): Promise>; @@ -481,7 +509,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ listCurrentInputMethodSubtype(callback: AsyncCallback>): void; @@ -492,7 +521,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ listCurrentInputMethodSubtype(): Promise>; @@ -508,7 +538,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getInputMethods(enable: boolean, callback: AsyncCallback>): void; @@ -524,7 +555,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ getInputMethods(enable: boolean): Promise>; @@ -540,7 +572,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getInputMethodsSync(enable: boolean): Array; @@ -551,7 +584,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllInputMethods(callback: AsyncCallback>): void; @@ -562,7 +596,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllInputMethods(): Promise>; @@ -573,7 +608,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800001 - bundle manager error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ getAllInputMethodsSync(): Array; @@ -650,7 +686,8 @@ declare namespace inputMethod { /** * @interface InputMethodController * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 6 + * @since arkts {'1.1':'6', '1.2':'20'} + * @arkts 1.1&1.2 */ interface InputMethodController { /** @@ -664,7 +701,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ attach(showKeyboard: boolean, textConfig: TextConfig, callback: AsyncCallback): void; /** @@ -678,7 +716,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ attach(showKeyboard: boolean, textConfig: TextConfig): Promise; /** @@ -693,7 +732,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ attach(showKeyboard: boolean, textConfig: TextConfig, requestKeyboardReason: RequestKeyboardReason): Promise; /** @@ -704,7 +744,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ showTextInput(callback: AsyncCallback): void; /** @@ -715,7 +756,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ showTextInput(): Promise; /** @@ -727,7 +769,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ showTextInput(requestKeyboardReason: RequestKeyboardReason): Promise; /** @@ -738,7 +781,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ hideTextInput(callback: AsyncCallback): void; @@ -750,7 +794,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800008 - input method manager service error. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ hideTextInput(): Promise; @@ -761,7 +806,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ detach(callback: AsyncCallback): void; @@ -772,7 +818,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ detach(): Promise; @@ -983,7 +1030,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ hideSoftKeyboard(callback: AsyncCallback): void; @@ -997,7 +1045,8 @@ declare namespace inputMethod { * @throws { BusinessError } 12800003 - input method client error. * @throws { BusinessError } 12800008 - input method manager service error. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ hideSoftKeyboard(): Promise; @@ -1040,7 +1089,8 @@ declare namespace inputMethod { * @throws { BusinessError } 401 - parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'selectByRange', callback: Callback): void; @@ -1051,7 +1101,8 @@ declare namespace inputMethod { * @param { Callback } [callback] - the callback of 'selectByRange', * when subscriber unsubscribes all callback functions of event 'selectByRange', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'selectByRange', callback?: Callback): void; @@ -1066,7 +1117,8 @@ declare namespace inputMethod { * @throws { BusinessError } 401 - parameter error. Possible causes: * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'selectByMovement', callback: Callback): void; @@ -1077,7 +1129,8 @@ declare namespace inputMethod { * @param { Callback } [callback] - the callback of 'selectByMovement', * when subscriber unsubscribes all callback functions of event 'selectByMovement', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'selectByMovement', callback?: Callback): void; @@ -1091,7 +1144,8 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'insertText', callback: (text: string) => void): void; @@ -1102,7 +1156,8 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'insertText', * when subscriber unsubscribes all callback functions of event 'insertText', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'insertText', callback?: (text: string) => void): void; @@ -1118,9 +1173,10 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'deleteLeft', callback: (length: number) => void): void; + on(type: 'deleteLeft', callback: (length: int) => void): void; /** * Unregister the callback of deleteLeft. @@ -1129,9 +1185,10 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'deleteLeft', * when subscriber unsubscribes all callback functions of event 'deleteLeft', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'deleteLeft', callback?: (length: number) => void): void; + off(type: 'deleteLeft', callback?: (length: int) => void): void; /** * Register a callback and when IME sends delete right event with length, @@ -1145,9 +1202,10 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'deleteRight', callback: (length: number) => void): void; + on(type: 'deleteRight', callback: (length: int) => void): void; /** * Unregister the callback of deleteRight. @@ -1156,9 +1214,10 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'deleteRight', * when subscriber unsubscribes all callback functions of event 'deleteRight', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'deleteRight', callback?: (length: number) => void): void; + off(type: 'deleteRight', callback?: (length: int) => void): void; /** * Register a callback and when IME sends keyboard status, the callback will be invoked. @@ -1170,7 +1229,8 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'sendKeyboardStatus', callback: (keyboardStatus: KeyboardStatus) => void): void; @@ -1181,7 +1241,8 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'sendKeyboardStatus', * when subscriber unsubscribes all callback functions of event 'sendKeyboardStatus', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'sendKeyboardStatus', callback?: (keyboardStatus: KeyboardStatus) => void): void; @@ -1196,7 +1257,8 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'sendFunctionKey', callback: (functionKey: FunctionKey) => void): void; @@ -1207,7 +1269,8 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'sendFunctionKey', * when subscriber unsubscribes all callback functions of event 'sendFunctionKey', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'sendFunctionKey', callback?: (functionKey: FunctionKey) => void): void; @@ -1222,7 +1285,8 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'moveCursor', callback: (direction: Direction) => void): void; @@ -1233,7 +1297,8 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'moveCursor', * when subscriber unsubscribes all callback functions of event 'moveCursor', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'moveCursor', callback?: (direction: Direction) => void): void; @@ -1247,7 +1312,8 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'handleExtendAction', callback: (action: ExtendAction) => void): void; @@ -1258,7 +1324,8 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'handleExtendAction', * when subscriber unsubscribes all callback functions of event 'handleExtendAction', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'handleExtendAction', callback?: (action: ExtendAction) => void): void; @@ -1272,9 +1339,10 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'getLeftTextOfCursor', callback: (length: number) => string): void; + on(type: 'getLeftTextOfCursor', callback: (length: int) => string): void; /** * Unregister the callback of getLeftTextOfCursor event. @@ -1283,9 +1351,10 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'getLeftTextOfCursor', * when subscriber unsubscribes all callback functions of event 'getLeftTextOfCursor', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'getLeftTextOfCursor', callback?: (length: number) => string): void; + off(type: 'getLeftTextOfCursor', callback?: (length: int) => string): void; /** * Register a callback and when input method ability gets right text of cursor, the callback will be invoked. @@ -1297,9 +1366,10 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'getRightTextOfCursor', callback: (length: number) => string): void; + on(type: 'getRightTextOfCursor', callback: (length: int) => string): void; /** * Unregister the callback of getRightTextOfCursor event. @@ -1308,9 +1378,10 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'getRightTextOfCursor', * when subscriber unsubscribes all callback functions of event 'getRightTextOfCursor', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'getRightTextOfCursor', callback?: (length: number) => string): void; + off(type: 'getRightTextOfCursor', callback?: (length: int) => string): void; /** * Register a callback and when input method ability gets the text index at cursor, the callback will be invoked. @@ -1322,9 +1393,10 @@ declare namespace inputMethod { * 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types; 3.Parameter verification failed. * @throws { BusinessError } 12800009 - input method client detached. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'getTextIndexAtCursor', callback: () => number): void; + on(type: 'getTextIndexAtCursor', callback: () => int): void; /** * Unregister the callback of getTextIndexAtCursor. @@ -1333,9 +1405,10 @@ declare namespace inputMethod { * @param { function } [callback] - the callback of 'getTextIndexAtCursor', * when subscriber unsubscribes all callback functions of event 'getTextIndexAtCursor', this parameter can be left blank. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'getTextIndexAtCursor', callback?: () => number): void; + off(type: 'getTextIndexAtCursor', callback?: () => int): void; } /** @@ -1343,7 +1416,8 @@ declare namespace inputMethod { * * @interface InputMethodProperty * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface InputMethodProperty { /** @@ -1374,7 +1448,8 @@ declare namespace inputMethod { * @type { string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly name: string; @@ -1384,7 +1459,8 @@ declare namespace inputMethod { * @type { string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly id: string; @@ -1394,7 +1470,8 @@ declare namespace inputMethod { * @type { ?string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly label?: string; @@ -1404,7 +1481,8 @@ declare namespace inputMethod { * @type { ?number } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly labelId?: number; @@ -1414,7 +1492,8 @@ declare namespace inputMethod { * @type { ?string } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly icon?: string; @@ -1424,7 +1503,8 @@ declare namespace inputMethod { * @type { ?number } * @readonly * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ readonly iconId?: number; @@ -1448,16 +1528,18 @@ declare namespace inputMethod { /** * Enumerates the moving direction of cursor * - * @enum { number } + * @enum { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum Direction { /** * Cursor moves up * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_UP = 1, @@ -1465,7 +1547,8 @@ declare namespace inputMethod { * Cursor moves down * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_DOWN, @@ -1473,7 +1556,8 @@ declare namespace inputMethod { * Cursor moves left * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_LEFT, @@ -1481,7 +1565,8 @@ declare namespace inputMethod { * Cursor moves right * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_RIGHT } @@ -1491,26 +1576,29 @@ declare namespace inputMethod { * * @typedef Range * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Range { /** * Indicates the index of the first character of the selected text. * - * @type { number } + * @type { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - start: number; + start: int; /** * Indicates the index of the last character of the selected text. * - * @type { number } + * @type { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - end: number; + end: int; } /** @@ -1518,7 +1606,8 @@ declare namespace inputMethod { * * @typedef Movement * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface Movement { /** @@ -1526,7 +1615,8 @@ declare namespace inputMethod { * * @type { Direction } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ direction: Direction; } @@ -1534,16 +1624,18 @@ declare namespace inputMethod { /** * Enumerates the text input type. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum TextInputType { /** * The text input type is NONE. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = -1, @@ -1551,7 +1643,8 @@ declare namespace inputMethod { * The text input type is TEXT. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ TEXT = 0, @@ -1559,7 +1652,8 @@ declare namespace inputMethod { * The text input type is MULTILINE. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ MULTILINE, @@ -1567,7 +1661,8 @@ declare namespace inputMethod { * The text input type is NUMBER. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER, @@ -1575,7 +1670,8 @@ declare namespace inputMethod { * The text input type is PHONE. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ PHONE, @@ -1583,7 +1679,8 @@ declare namespace inputMethod { * The text input type is DATETIME. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ DATETIME, @@ -1591,7 +1688,8 @@ declare namespace inputMethod { * The text input type is EMAIL_ADDRESS. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ EMAIL_ADDRESS, @@ -1599,7 +1697,8 @@ declare namespace inputMethod { * The text input type is URL. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ URL, @@ -1607,7 +1706,8 @@ declare namespace inputMethod { * The text input type is VISIBLE_PASSWORD. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ VISIBLE_PASSWORD, @@ -1615,7 +1715,8 @@ declare namespace inputMethod { * The text input type is NUMBER_PASSWORD. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER_PASSWORD } @@ -1623,16 +1724,18 @@ declare namespace inputMethod { /** * Enumerates the enter key type. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum EnterKeyType { /** * The enter key type is UNSPECIFIED. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ UNSPECIFIED = 0, @@ -1640,7 +1743,8 @@ declare namespace inputMethod { * The enter key type is NONE. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE, @@ -1648,7 +1752,8 @@ declare namespace inputMethod { * The enter key type is GO. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ GO, @@ -1656,7 +1761,8 @@ declare namespace inputMethod { * The enter key type is SEARCH. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SEARCH, @@ -1664,7 +1770,8 @@ declare namespace inputMethod { * The enter key type is SEND. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SEND, @@ -1672,7 +1779,8 @@ declare namespace inputMethod { * The enter key type is NEXT. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NEXT, @@ -1680,7 +1788,8 @@ declare namespace inputMethod { * The enter key type is DONE. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ DONE, @@ -1688,7 +1797,8 @@ declare namespace inputMethod { * The enter key type is PREVIOUS. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ PREVIOUS, @@ -1696,7 +1806,8 @@ declare namespace inputMethod { * The enter key type is NEWLINE. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NEWLINE } @@ -1704,16 +1815,18 @@ declare namespace inputMethod { /** * Enumerates the keyboard status. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum KeyboardStatus { /** * The keyboard status is none. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -1721,7 +1834,8 @@ declare namespace inputMethod { * The keyboard status is hide. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ HIDE = 1, @@ -1729,7 +1843,8 @@ declare namespace inputMethod { * The keyboard status is show. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SHOW = 2 } @@ -1739,7 +1854,8 @@ declare namespace inputMethod { * * @typedef InputAttribute * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface InputAttribute { /** @@ -1747,7 +1863,8 @@ declare namespace inputMethod { * * @type { TextInputType } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ textInputType: TextInputType; @@ -1756,7 +1873,8 @@ declare namespace inputMethod { * * @type { EnterKeyType } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType: EnterKeyType; } @@ -1766,7 +1884,8 @@ declare namespace inputMethod { * * @typedef FunctionKey * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface FunctionKey { /** @@ -1774,7 +1893,8 @@ declare namespace inputMethod { * * @type { EnterKeyType } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enterKeyType: EnterKeyType; } @@ -1784,7 +1904,8 @@ declare namespace inputMethod { * * @typedef CursorInfo * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface CursorInfo { /** @@ -1792,7 +1913,8 @@ declare namespace inputMethod { * * @type { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ left: number; @@ -1801,7 +1923,8 @@ declare namespace inputMethod { * * @type { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ top: number; @@ -1810,7 +1933,8 @@ declare namespace inputMethod { * * @type { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -1819,7 +1943,8 @@ declare namespace inputMethod { * * @type { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -1829,7 +1954,8 @@ declare namespace inputMethod { * * @typedef TextConfig * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface TextConfig { /** @@ -1837,7 +1963,8 @@ declare namespace inputMethod { * * @type { InputAttribute } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ inputAttribute: InputAttribute; @@ -1846,7 +1973,8 @@ declare namespace inputMethod { * * @type { ?CursorInfo } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ cursorInfo?: CursorInfo; @@ -1855,33 +1983,37 @@ declare namespace inputMethod { * * @type { ?Range } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ selection?: Range; /** * The window ID of the application currently bound to the input method. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - windowId?: number; + windowId?: int; } /** * Enumerates the extend action. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ExtendAction { /** * Select all text. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ SELECT_ALL = 0, @@ -1889,7 +2021,8 @@ declare namespace inputMethod { * Cut selecting text. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CUT = 3, @@ -1897,7 +2030,8 @@ declare namespace inputMethod { * Copy selecting text. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ COPY = 4, @@ -1905,7 +2039,8 @@ declare namespace inputMethod { * Paste from paste board. * * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ PASTE = 5 } @@ -1915,7 +2050,8 @@ declare namespace inputMethod { * * @typedef InputWindowInfo * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface InputWindowInfo { /** @@ -1923,34 +2059,38 @@ declare namespace inputMethod { * * @type { string } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; /** * Indicates the abscissa of the upper-left vertex of input window. * - * @type { number } + * @type { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - left: number; + left: int; /** * Indicates the ordinate of the upper-left vertex of input window. * - * @type { number } + * @type { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - top: number; + top: int; /** * Indicates the width of the input window. * * @type { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -1959,7 +2099,8 @@ declare namespace inputMethod { * * @type { number } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -2028,33 +2169,38 @@ declare namespace inputMethod { /** * requestKeyboardReason of input click * - * @enum { number } + * @enum { int } * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum RequestKeyboardReason { /** * The request keyboard reason is NONE. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, /** * The request keyboard reason is MOUSE. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ MOUSE = 1, /** * The request keyboard reason is TOUCH. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCH = 2, /** * The request keyboard reason is OTHER. * @syscap SystemCapability.MiscServices.InputMethodFramework - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ OTHER = 20 } diff --git a/api/@ohos.intl.d.ts b/api/@ohos.intl.d.ts index 54fa45dcad24705958624f48181c0371392018a2..44c1c2cbefca9645444503947313404bd092b707 100644 --- a/api/@ohos.intl.d.ts +++ b/api/@ohos.intl.d.ts @@ -50,7 +50,8 @@ * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace intl { /** @@ -85,7 +86,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface LocaleOptions { /** @@ -127,7 +129,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ calendar?: string; @@ -170,7 +173,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ collation?: string; @@ -213,7 +217,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ hourCycle?: string; @@ -256,7 +261,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numberingSystem?: string; @@ -299,7 +305,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numeric?: boolean; @@ -342,7 +349,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ caseFirst?: string; } @@ -375,7 +383,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class Locale { /** @@ -406,7 +415,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -450,7 +460,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale: string, options?: LocaleOptions); @@ -788,6 +799,148 @@ declare namespace intl { */ numeric: boolean; + /*** if arkts 1.2 */ + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get language(): string; + set language(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get script(): string; + set script(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get region(): string; + set region(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get baseName(): string; + set baseName(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get caseFirst(): string; + set caseFirst(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get calendar(): string; + set calendar(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get collation(): string; + set collation(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get hourCycle(): string; + set hourCycle(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get numberingSystem(): string; + set numberingSystem(value: string); + + /** + * Indicates the language of the locale. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @form + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + get numeric(): boolean; + set numeric(value: boolean); + /*** endif */ + /** * Convert the locale information to string. * @@ -820,7 +973,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ toString(): string; @@ -856,7 +1010,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maximize(): Locale; @@ -892,7 +1047,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimize(): Locale; } @@ -929,7 +1085,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface DateTimeOptions { /** @@ -971,7 +1128,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -1014,7 +1172,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ dateStyle?: string; @@ -1057,7 +1216,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ timeStyle?: string; @@ -1100,7 +1260,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ hourCycle?: string; @@ -1143,7 +1304,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ timeZone?: string; @@ -1186,7 +1348,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numberingSystem?: string; @@ -1229,7 +1392,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ hour12?: boolean; @@ -1272,7 +1436,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ weekday?: string; @@ -1315,7 +1480,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ era?: string; @@ -1358,7 +1524,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ year?: string; @@ -1401,7 +1568,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ month?: string; @@ -1444,7 +1612,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ day?: string; @@ -1487,7 +1656,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ hour?: string; @@ -1530,7 +1700,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minute?: string; @@ -1573,7 +1744,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ second?: string; @@ -1616,7 +1788,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ timeZoneName?: string; @@ -1659,7 +1832,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ dayPeriod?: string; @@ -1702,7 +1876,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ localeMatcher?: string; @@ -1745,7 +1920,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ formatMatcher?: string; } @@ -1778,7 +1954,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class DateTimeFormat { /** @@ -1809,7 +1986,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -1853,7 +2031,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale: string | Array, options?: DateTimeOptions); @@ -1893,7 +2072,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ format(date: Date): string; @@ -1937,7 +2117,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ formatRange(startDate: Date, endDate: Date): string; @@ -1973,7 +2154,8 @@ declare namespace intl { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ resolvedOptions(): DateTimeOptions; } @@ -2000,7 +2182,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface NumberOptions { /** @@ -2032,7 +2215,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ locale?: string; @@ -2065,7 +2249,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ currency?: string; @@ -2098,7 +2283,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ currencySign?: string; @@ -2131,7 +2317,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ currencyDisplay?: string; @@ -2164,7 +2351,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ unit?: string; @@ -2197,7 +2385,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ unitDisplay?: string; @@ -2230,7 +2419,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ unitUsage?: string; @@ -2263,7 +2453,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ signDisplay?: string; @@ -2296,7 +2487,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ compactDisplay?: string; @@ -2329,7 +2521,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ notation?: string; @@ -2362,7 +2555,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ localeMatcher?: string; @@ -2395,7 +2589,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ style?: string; @@ -2428,7 +2623,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numberingSystem?: string; @@ -2461,7 +2657,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ useGrouping?: boolean; @@ -2494,7 +2691,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimumIntegerDigits?: number; @@ -2527,7 +2725,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimumFractionDigits?: number; @@ -2560,7 +2759,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maximumFractionDigits?: number; @@ -2593,7 +2793,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimumSignificantDigits?: number; @@ -2626,7 +2827,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maximumSignificantDigits?: number; @@ -2636,7 +2838,8 @@ declare namespace intl { * @type { ?string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ roundingPriority?: string; @@ -2647,7 +2850,8 @@ declare namespace intl { * @type { ?number } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ roundingIncrement?: number; @@ -2657,7 +2861,8 @@ declare namespace intl { * @type { ?string } * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ roundingMode?: string; } @@ -2681,7 +2886,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class NumberFormat { /** @@ -2703,7 +2909,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -2735,7 +2942,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale: string | Array, options?: NumberOptions); @@ -2764,7 +2972,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ format(number: number): string; @@ -2776,7 +2985,8 @@ declare namespace intl { * @returns { string } a number range string formatted based on the specified locale. * @syscap SystemCapability.Global.I18n * @atomicservice - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ formatRange(startRange: number, endRange: number): string; @@ -2802,7 +3012,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ resolvedOptions(): NumberOptions; } @@ -2829,7 +3040,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface CollatorOptions { /** @@ -2865,7 +3077,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ localeMatcher?: string; @@ -2902,7 +3115,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ usage?: string; @@ -2963,7 +3177,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ sensitivity?: string; @@ -2996,7 +3211,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ignorePunctuation?: boolean; @@ -3029,7 +3245,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ collation?: string; @@ -3062,7 +3279,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numeric?: boolean; @@ -3099,7 +3317,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ caseFirst?: string; } @@ -3123,7 +3342,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class Collator { /** @@ -3145,7 +3365,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); /** @@ -3176,7 +3397,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale: string | Array, options?: CollatorOptions); @@ -3217,7 +3439,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ compare(first: string, second: string): number; @@ -3246,7 +3469,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ resolvedOptions(): CollatorOptions; } @@ -3273,7 +3497,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface PluralRulesOptions { /** @@ -3309,7 +3534,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ localeMatcher?: string; @@ -3342,7 +3568,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type?: string; @@ -3379,7 +3606,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimumIntegerDigits?: number; @@ -3416,7 +3644,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimumFractionDigits?: number; @@ -3457,7 +3686,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maximumFractionDigits?: number; @@ -3494,7 +3724,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ minimumSignificantDigits?: number; @@ -3531,7 +3762,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ maximumSignificantDigits?: number; } @@ -3555,7 +3787,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class PluralRules { /** @@ -3577,7 +3810,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3609,7 +3843,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale: string | Array, options?: PluralRulesOptions); @@ -3641,7 +3876,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ select(n: number): string; } @@ -3668,7 +3904,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface RelativeTimeFormatInputOptions { /** @@ -3704,7 +3941,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ localeMatcher?: string; @@ -3741,7 +3979,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numeric?: string; @@ -3778,7 +4017,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ style?: string; } @@ -3805,7 +4045,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface RelativeTimeFormatResolvedOptions { /** @@ -3828,7 +4069,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ locale: string; @@ -3855,7 +4097,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ style: string; @@ -3882,7 +4125,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numeric: string; @@ -3906,11 +4150,52 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numberingSystem: string; } + /** + * Provides the part of RelativeTimeFormat. + * + * @interface RelativeTimeFormatPart + * @syscap SystemCapability.Global.I18n + * @since 20 + * @arkts 1.2 + */ + export interface RelativeTimeFormatPart { + /** + * The type of the part. + * + * @type { string } + * @syscap SystemCapability.Global.I18n + * @since 20 + * @arkts 1.2 + */ + type: string; + + /** + * The value of the part. + * + * @type { number } + * @syscap SystemCapability.Global.I18n + * @since 20 + * @arkts 1.2 + */ + value: number; + + /** + * The unit of the part. + * + * @type { ?string } + * @syscap SystemCapability.Global.I18n + * @since 20 + * @arkts 1.2 + */ + unit?: string; + } + /** * Given a Time period length value and a unit, RelativeTimeFormat object enables * language-sensitive relative time formatting. @@ -3933,7 +4218,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export class RelativeTimeFormat { /** @@ -3955,7 +4241,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(); @@ -3987,7 +4274,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ constructor(locale: string | Array, options?: RelativeTimeFormatInputOptions); @@ -4022,7 +4310,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ format(value: number, unit: string): string; @@ -4064,6 +4353,22 @@ declare namespace intl { */ formatToParts(value: number, unit: string): Array; + /** + * returns an Array of objects representing the relative time format in parts that can be used for + * custom locale-aware formatting + * + * @param { number } value - Numeric value to use in the internationalized relative time message. + * @param { string } unit - to use in the relative time internationalized message. + * Possible values are: year, quarter, month, week, day, hour, minute, second. + * @returns { Array } an Array of RelativeTimeFormatPart representing the relative time format in parts + * @syscap SystemCapability.Global.I18n + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + formatToParts(value: number, unit: string): Array; + /** * Returns a new object with properties that reflect the locale and formatting options computed during * initialization of the object. @@ -4089,7 +4394,8 @@ declare namespace intl { * @syscap SystemCapability.Global.I18n * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ resolvedOptions(): RelativeTimeFormatResolvedOptions; } diff --git a/api/@ohos.logLibrary.d.ets b/api/@ohos.logLibrary.d.ets new file mode 100644 index 0000000000000000000000000000000000000000..a1c3f1b3a7b368ba68c038a5f6d492fcb3cc793c --- /dev/null +++ b/api/@ohos.logLibrary.d.ets @@ -0,0 +1,192 @@ +/* + * Copyright (c) 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 PerformanceAnalysisKit + */ + +import type { AsyncCallback } from './@ohos.base'; + +/** + * @namespace logLibrary + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ +declare namespace logLibrary { + /** + * Log file entry + * + * @typedef LogEntry + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export interface LogEntry { + /** + * Log file name + * + * @type { string } + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + name: string; + + /** + * File modification time, expressed by the number of seconds elapsed from 1970-01-01 + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + mtime: number; + + /** + * Log file size, byte + * + * @type { number } + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + size: number; + } + + /** + * List all log names of log type + * + * @permission ohos.permission.READ_HIVIEW_SYSTEM + * @param { string } logType - Log type + * @returns { LogEntry[] } Return LogEntry[] + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Permission denied, non-system app called system api + * @throws { BusinessError } 401 - Invalid argument. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + *
3. Parameter verification failed. + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export function list(logType: string): LogEntry[]; + + /** + * Copy log to dest path + * + * @permission ohos.permission.READ_HIVIEW_SYSTEM + * @param { string } logType - Log type + * @param { string } logName - Log name + * @param { string } dest - Log path under hiview sandbox of HAP + * @returns { Promise } Return Promise + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Permission denied, non-system app called system api + * @throws { BusinessError } 401 - Invalid argument. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + *
3. Parameter verification failed. + * @throws { BusinessError } 21300001 - Source file does not exists + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export function copy(logType: string, logName: string, dest: string): Promise; + + /** + * Copy log to dest path + * + * @permission ohos.permission.READ_HIVIEW_SYSTEM + * @param { string } logType - Log type + * @param { string } logName - Log name + * @param { string } dest - Log path under hiview sandbox of HAP + * @param { AsyncCallback } callback - After finish copy log will callback + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Permission denied, non-system app called system api + * @throws { BusinessError } 401 - Invalid argument. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + *
3. Parameter verification failed. + * @throws { BusinessError } 21300001 - Source file does not exists + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export function copy(logType: string, logName: string, dest: string, callback: AsyncCallback): void; + + /** + * Move log to dest path + * + * @permission ohos.permission.WRITE_HIVIEW_SYSTEM + * @param { string } logType - Log type + * @param { string } logName - Log name + * @param { string } dest - Log path under hiview sandbox of HAP + * @returns { Promise } Return Promise + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Permission denied, non-system app called system api + * @throws { BusinessError } 401 - Invalid argument. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + *
3. Parameter verification failed. + * @throws { BusinessError } 21300001 - Source file does not exists + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export function move(logType: string, logName: string, dest: string): Promise; + + /** + * Move log to dest path + * + * @permission ohos.permission.WRITE_HIVIEW_SYSTEM + * @param { string } logType - Log type + * @param { string } logName - Log name + * @param { string } dest - Log path under hiview sandbox of HAP + * @param { AsyncCallback } callback - After finish move log will callback + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Permission denied, non-system app called system api + * @throws { BusinessError } 401 - Invalid argument. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + *
3. Parameter verification failed. + * @throws { BusinessError } 21300001 - Source file does not exists + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export function move(logType: string, logName: string, dest: string, callback: AsyncCallback): void; + + /** + * Delete the log based on log name and log type + * + * @permission ohos.permission.WRITE_HIVIEW_SYSTEM + * @param { string } logType - Log type + * @param { string } logName - Log name + * @throws { BusinessError } 201 - Permission denied + * @throws { BusinessError } 202 - Permission denied, non-system app called system api + * @throws { BusinessError } 401 - Invalid argument. Possible causes: + *
1. Mandatory parameters are left unspecified. + *
2. Incorrect parameter types. + *
3. Parameter verification failed. + * @throws { BusinessError } 21300001 - Source file does not exists + * @syscap SystemCapability.HiviewDFX.Hiview.LogLibrary + * @systemapi + * @since 20 + */ + export function remove(logType: string, logName: string): void; +} + +export default logLibrary; diff --git a/api/@ohos.matrix4.d.ts b/api/@ohos.matrix4.d.ts index b3ecb07699a87125d1eea6c4997c217ea13e8882..697edb1b708d84a4afa700fdfb7d9c541063f762 100644 --- a/api/@ohos.matrix4.d.ts +++ b/api/@ohos.matrix4.d.ts @@ -40,7 +40,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace matrix4 { /** @@ -65,7 +66,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface TranslateOption { /** @@ -90,7 +92,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; @@ -116,7 +119,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; @@ -142,7 +146,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ z?: number; } @@ -169,7 +174,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScaleOption { /** @@ -194,7 +200,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; @@ -220,7 +227,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; @@ -246,7 +254,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ z?: number; @@ -272,7 +281,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerX?: number; @@ -298,7 +308,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerY?: number; } @@ -325,7 +336,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface RotateOption { /** @@ -350,7 +362,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ x?: number; @@ -376,7 +389,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ y?: number; @@ -402,7 +416,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ z?: number; @@ -428,7 +443,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerX?: number; @@ -454,7 +470,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ centerY?: number; @@ -480,7 +497,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ angle?: number; } @@ -493,7 +511,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface Point { @@ -504,7 +523,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -515,7 +535,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -527,7 +548,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface PolyToPolyOptions { @@ -538,7 +560,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ src: Array; @@ -549,7 +572,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ srcIndex?: number; @@ -560,7 +584,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dst:Array; @@ -572,7 +597,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dstIndex?: number; @@ -586,7 +612,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pointCount?:number; @@ -613,7 +640,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface Matrix4Transit { /** @@ -638,7 +666,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ copy(): Matrix4Transit; @@ -664,7 +693,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ invert(): Matrix4Transit; @@ -693,7 +723,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ combine(options: Matrix4Transit): Matrix4Transit; @@ -722,7 +753,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ translate(options: TranslateOption): Matrix4Transit; @@ -751,7 +783,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ scale(options: ScaleOption): Matrix4Transit; @@ -766,7 +799,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ skew(x: number, y: number): Matrix4Transit; @@ -795,7 +829,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ rotate(options: RotateOption): Matrix4Transit; @@ -824,7 +859,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ transformPoint(options: [number, number]): [number, number]; @@ -836,7 +872,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setPolyToPoly(options: PolyToPolyOptions): Matrix4Transit @@ -935,7 +972,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function init( options: [ @@ -980,7 +1018,8 @@ declare namespace matrix4 { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function identity(): Matrix4Transit; diff --git a/api/@ohos.measure.d.ts b/api/@ohos.measure.d.ts index 8418f45f655549d87596938803983727d64e2858..4df04ccd50f063a9bf987b413ed4ba8aba399d4f 100644 --- a/api/@ohos.measure.d.ts +++ b/api/@ohos.measure.d.ts @@ -18,6 +18,11 @@ * @kit ArkUI */ +/*** if arkts 1.2 */ +import { FontStyle, FontWeight, TextAlign, TextOverflow, TextCase, WordBreak } from './arkui/component/enums' +import { SizeOptions } from './arkui/component/units'; +import { Resource } from './global/resource' +/*** endif */ /** * Defines the options of MeasureText. @@ -41,7 +46,8 @@ * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface MeasureOptions { /** @@ -65,7 +71,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textContent: string | Resource; @@ -83,7 +90,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ constraintWidth?: number | string | Resource; @@ -101,7 +109,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontSize?: number | string | Resource; @@ -119,7 +128,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontStyle?: number | FontStyle; @@ -137,7 +147,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontWeight?: number | string | FontWeight; @@ -155,7 +166,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fontFamily?: string | Resource; @@ -173,7 +185,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ letterSpacing?: number | string; @@ -191,7 +204,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textAlign?: number | TextAlign; @@ -209,7 +223,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ overflow?: number | TextOverflow; @@ -227,7 +242,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ maxLines?: number; @@ -245,7 +261,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ lineHeight?: number | string | Resource; @@ -263,7 +280,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ baselineOffset?: number | string; @@ -281,7 +299,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textCase?: number | TextCase; @@ -300,7 +319,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textIndent?: number | string; @@ -319,7 +339,8 @@ export interface MeasureOptions { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ wordBreak?: WordBreak; } diff --git a/api/@ohos.mediaquery.d.ts b/api/@ohos.mediaquery.d.ts index eea1e126235de20fe746504523c520a9bae251c5..16540d063afab82db2b618c99e1ffbc50b0d4f21 100644 --- a/api/@ohos.mediaquery.d.ts +++ b/api/@ohos.mediaquery.d.ts @@ -18,7 +18,13 @@ * @kit ArkUI */ +/*** if arkts 1.1 */ import { Callback } from './@ohos.base'; +/*** endif */ + +/*** if arkts 1.2 */ +import { Callback } from './@ohos.base'; +/*** endif */ /** * Used to do mediaquery operations. @@ -52,7 +58,8 @@ import { Callback } from './@ohos.base'; * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ declare namespace mediaquery { @@ -88,7 +95,8 @@ declare namespace mediaquery { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ interface MediaQueryResult { /** @@ -131,7 +139,8 @@ declare namespace mediaquery { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ readonly matches: boolean; @@ -175,7 +184,8 @@ declare namespace mediaquery { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ readonly media: string; } @@ -216,7 +226,8 @@ declare namespace mediaquery { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ interface MediaQueryListener extends MediaQueryResult { /** @@ -259,7 +270,8 @@ declare namespace mediaquery { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ on(type: 'change', callback: Callback): void; @@ -303,7 +315,8 @@ declare namespace mediaquery { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts { '1.1':'12','1.2':'20' } + * @arkts 1.1&1.2 */ off(type: 'change', callback?: Callback): void; } diff --git a/api/@ohos.multimedia.audio.d.ts b/api/@ohos.multimedia.audio.d.ts index e25e77e07181a248e875e76199089f3ca6302911..4e9a3a755fa186cdd5ba14a4940316d66ec65023 100644 --- a/api/@ohos.multimedia.audio.d.ts +++ b/api/@ohos.multimedia.audio.d.ts @@ -29,7 +29,8 @@ import { ErrorCallback, AsyncCallback, Callback } from './@ohos.base'; * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace audio { /** @@ -159,7 +160,8 @@ declare namespace audio { * @returns { AudioManager } this {@link AudioManager} object. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getAudioManager(): AudioManager; @@ -270,7 +272,8 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioState { /** @@ -282,7 +285,8 @@ declare namespace audio { * Invalid state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_INVALID = -1, /** @@ -294,7 +298,8 @@ declare namespace audio { * Create new instance state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_NEW = 0, /** @@ -306,7 +311,8 @@ declare namespace audio { * Prepared state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_PREPARED = 1, /** @@ -318,7 +324,8 @@ declare namespace audio { * Running state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_RUNNING = 2, /** @@ -330,7 +337,8 @@ declare namespace audio { * Stopped state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_STOPPED = 3, /** @@ -342,7 +350,8 @@ declare namespace audio { * Released state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_RELEASED = 4, /** @@ -354,7 +363,8 @@ declare namespace audio { * Paused state. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_PAUSED = 5 } @@ -370,7 +380,8 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioVolumeType { /** @@ -382,7 +393,8 @@ declare namespace audio { * Audio streams for voice calls. * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VOICE_CALL = 0, /** @@ -394,7 +406,8 @@ declare namespace audio { * Audio streams for ringtones. * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RINGTONE = 2, /** @@ -406,7 +419,8 @@ declare namespace audio { * Audio streams for media purpose. * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA = 3, /** @@ -418,7 +432,8 @@ declare namespace audio { * Audio volume for alarm purpose. * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALARM = 4, /** @@ -430,27 +445,31 @@ declare namespace audio { * Audio volume for accessibility purpose. * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ACCESSIBILITY = 5, /** * Audio stream for voice assistant. * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ VOICE_ASSISTANT = 9, /** * Audio volume for ultrasonic. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ULTRASONIC = 10, /** * Audio stream for all common. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ ALL = 100, } @@ -466,14 +485,16 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeviceFlag { /** * None devices. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ NONE_DEVICES_FLAG = 0, /** @@ -485,7 +506,8 @@ declare namespace audio { * Output devices. * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OUTPUT_DEVICES_FLAG = 1, /** @@ -497,7 +519,8 @@ declare namespace audio { * Input devices. * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INPUT_DEVICES_FLAG = 2, /** @@ -509,28 +532,32 @@ declare namespace audio { * All devices. * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALL_DEVICES_FLAG = 3, /** * Distributed output devices. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DISTRIBUTED_OUTPUT_DEVICES_FLAG = 4, /** * Distributed input devices. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ DISTRIBUTED_INPUT_DEVICES_FLAG = 8, /** * All Distributed devices. * @syscap SystemCapability.Multimedia.Audio.Device * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ ALL_DISTRIBUTED_DEVICES_FLAG = 12, } @@ -539,43 +566,50 @@ declare namespace audio { * Enumerates audio device for usage. * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeviceUsage { /** * Media output devices. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA_OUTPUT_DEVICES = 1, /** * Media input devices. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA_INPUT_DEVICES = 2, /** * All media devices. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALL_MEDIA_DEVICES = 3, /** * Call output devices. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_OUTPUT_DEVICES = 4, /** * Call input devices. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_INPUT_DEVICES = 8, /** * All call devices. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALL_CALL_DEVICES = 12, } @@ -592,7 +626,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeviceRole { /** @@ -605,7 +640,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INPUT_DEVICE = 1, /** @@ -618,7 +654,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OUTPUT_DEVICE = 2, } @@ -635,7 +672,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeviceType { /** @@ -648,7 +686,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INVALID = 0, /** @@ -661,7 +700,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EARPIECE = 1, /** @@ -674,7 +714,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEAKER = 2, /** @@ -687,7 +728,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WIRED_HEADSET = 3, /** @@ -700,7 +742,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WIRED_HEADPHONES = 4, /** @@ -713,7 +756,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BLUETOOTH_SCO = 7, /** @@ -726,7 +770,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BLUETOOTH_A2DP = 8, /** @@ -739,7 +784,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MIC = 15, /** @@ -752,46 +798,53 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USB_HEADSET = 22, /** * Display port device. * @syscap SystemCapability.Multimedia.Audio.Device * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISPLAY_PORT = 23, /** * Device type for rerouting audio to other remote devices by system application * @syscap SystemCapability.Multimedia.Audio.Device * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REMOTE_CAST = 24, /** * USB audio device. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ USB_DEVICE = 25, /** * HDMI device, such as HDMI, ARC, eARC * @syscap SystemCapability.Multimedia.Audio.Device - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ HDMI = 27, /** * Line connected digital output device, such as s/pdif * @syscap SystemCapability.Multimedia.Audio.Device - * @since 18 + * @since arkts {'1.1':'19','1.2':'20'} + * @arkts 1.1&1.2 */ LINE_DIGITAL = 28, /** * Distributed virtualization audio device. * @syscap SystemCapability.Multimedia.Audio.Device * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ REMOTE_DAUDIO = 29, /** @@ -804,7 +857,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 1000, } @@ -874,7 +928,8 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioRingMode { /** @@ -886,7 +941,8 @@ declare namespace audio { * Silent mode. * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RINGER_MODE_SILENT = 0, /** @@ -898,7 +954,8 @@ declare namespace audio { * Vibration mode. * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RINGER_MODE_VIBRATE = 1, /** @@ -910,7 +967,8 @@ declare namespace audio { * Normal mode. * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RINGER_MODE_NORMAL = 2, } @@ -920,21 +978,24 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PolicyType { /** * EDM type. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EDM = 0, /** * PRIVACY type. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIVACY = 1, } @@ -1377,7 +1438,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioEncodingType { /** @@ -1390,7 +1452,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ENCODING_TYPE_INVALID = -1, /** @@ -1403,7 +1466,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ENCODING_TYPE_RAW = 0 } @@ -1479,7 +1543,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum StreamUsage { /** @@ -1492,7 +1557,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_UNKNOWN = 0, /** @@ -1516,7 +1582,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_MUSIC = 1, /** @@ -1529,7 +1596,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_VOICE_COMMUNICATION = 2, /** @@ -1542,7 +1610,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_VOICE_ASSISTANT = 3, /** @@ -1555,7 +1624,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_ALARM = 4, /** @@ -1567,7 +1637,8 @@ declare namespace audio { * Voice message usage. * @syscap SystemCapability.Multimedia.Audio.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_VOICE_MESSAGE = 5, /** @@ -1588,7 +1659,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_RINGTONE = 6, /** @@ -1601,7 +1673,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_NOTIFICATION = 7, /** @@ -1614,14 +1687,16 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_ACCESSIBILITY = 8, /** * System usage, such as screen lock or key click. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_SYSTEM = 9, /** @@ -1634,7 +1709,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_MOVIE = 10, /** @@ -1647,7 +1723,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_GAME = 11, /** @@ -1660,7 +1737,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_AUDIOBOOK = 12, /** @@ -1673,42 +1751,48 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_NAVIGATION = 13, /** * DTMF dial tone usage. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_DTMF = 14, /** * Enforced tone usage, such as camera shutter. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_ENFORCED_TONE = 15, /** * Ultrasonic playing usage. This type is only used for msdp condition. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_ULTRASONIC = 16, /** * Video call usage. * @syscap SystemCapability.Multimedia.Audio.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_VIDEO_COMMUNICATION = 17, /** * Voice call assistant type. This type is only used for call assistant functionalities. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STREAM_USAGE_VOICE_CALL_ASSISTANT = 21, } @@ -1846,7 +1930,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioRendererInfo { /** @@ -1876,7 +1961,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ usage: StreamUsage; /** @@ -1891,17 +1977,10 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rendererFlags: number; - /** - * Audio volume mode config. If volumeMode is set to {@link AudioVolumeMode.APP_INDIVIDUAL}, this audio renderer - * will be affeted by app volume percentage setted by {@link setAppVolumePercentage} - * @type { ?AudioVolumeMode } - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - volumeMode?: AudioVolumeMode; } /** @@ -1938,32 +2017,6 @@ declare namespace audio { rendererId?: number; } - /** - * Describe audio capturer filter. - * @typedef AudioCapturerFilter - * @syscap SystemCapability.Multimedia.Audio.Core - * @systemapi - * @since 18 - */ - interface AudioCapturerFilter { - /** - * Application uid. - * @type { ?number } - * @syscap SystemCapability.Multimedia.Audio.Core - * @systemapi - * @since 18 - */ - uid?: number; - /** - * Capturer information. - * @type { ?AudioCapturerInfo } - * @syscap SystemCapability.Multimedia.Audio.Capturer - * @systemapi - * @since 18 - */ - capturerInfo?: AudioCapturerInfo; - } - /** * Describes audio renderer configuration options. * @typedef AudioRendererOptions @@ -2075,7 +2128,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Interrupt * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum InterruptMode { /** @@ -2088,7 +2142,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Interrupt * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHARE_MODE = 0, /** @@ -2101,7 +2156,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Interrupt * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INDEPENDENT_MODE = 1 } @@ -2145,7 +2201,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum InterruptType { /** @@ -2158,7 +2215,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_TYPE_BEGIN = 1, @@ -2172,7 +2230,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_TYPE_END = 2 } @@ -2189,7 +2248,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum InterruptHint { /** @@ -2214,7 +2274,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_HINT_RESUME = 1, @@ -2227,7 +2288,8 @@ declare namespace audio { * Paused/Pause the playback. * @syscap SystemCapability.Multimedia.Audio.Renderer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_HINT_PAUSE = 2, @@ -2240,7 +2302,8 @@ declare namespace audio { * Stopped/Stop the playback. * @syscap SystemCapability.Multimedia.Audio.Renderer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_HINT_STOP = 3, @@ -2283,7 +2346,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum InterruptForceType { /** @@ -2296,7 +2360,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_FORCE = 0, /** @@ -2308,7 +2373,8 @@ declare namespace audio { * Share type, application can choose to take action or ignore. * @syscap SystemCapability.Multimedia.Audio.Renderer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ INTERRUPT_SHARE = 1 } @@ -2325,7 +2391,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface InterruptEvent { /** @@ -2340,7 +2407,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ eventType: InterruptType; @@ -2372,7 +2440,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ hintType: InterruptHint; } @@ -2414,7 +2483,8 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeviceChangeType { /** @@ -2426,7 +2496,8 @@ declare namespace audio { * Device connection. * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONNECT = 0, @@ -2439,7 +2510,8 @@ declare namespace audio { * Device disconnection. * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DISCONNECT = 1, } @@ -2455,7 +2527,8 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioScene { /** @@ -2467,19 +2540,22 @@ declare namespace audio { * Default audio scene * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SCENE_DEFAULT = 0, /** * Ringing audio scene * @syscap SystemCapability.Multimedia.Audio.Communication - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SCENE_RINGING = 1, /** * Phone call audio scene * @syscap SystemCapability.Multimedia.Audio.Communication - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SCENE_PHONE_CALL = 2, /** @@ -2491,7 +2567,8 @@ declare namespace audio { * Voice chat audio scene * @syscap SystemCapability.Multimedia.Audio.Communication * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SCENE_VOICE_CHAT = 3 } @@ -2501,21 +2578,24 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum VolumeAdjustType { /** * Adjust volume up. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ VOLUME_UP = 0, /** * Adjust volume down. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ VOLUME_DOWN = 1, } @@ -2531,7 +2611,8 @@ declare namespace audio { * @typedef AudioManager * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioManager { /** @@ -3055,7 +3136,8 @@ declare namespace audio { * @returns { AudioVolumeManager } AudioVolumeManager instance. * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getVolumeManager(): AudioVolumeManager; @@ -3183,19 +3265,22 @@ declare namespace audio { * Desribes audio device block status. By default, the device is consider as unblocked. * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Device - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ - enum DeviceBlockStatus{ + enum DeviceBlockStatus { /** * Device is unblocked. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ UNBLOCKED = 0, /** * Device is blocked. * @syscap SystemCapability.Multimedia.Audio.Device - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ BLOCKED = 1, } @@ -3547,22 +3632,6 @@ declare namespace audio { */ selectInputDevice(inputAudioDevices: AudioDeviceDescriptors): Promise; - /** - * Select the input device with desired AudioCapturer. This method uses a promise to return the result. - * @param { AudioCapturerFilter } filter - Filter for AudioCapturer. - * @param { AudioDeviceDescriptors } inputAudioDevices - Audio device descriptions - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Device - * @systemapi - * @since 18 - */ - selectInputDeviceByFilter(filter: AudioCapturerFilter, inputAudioDevices: AudioDeviceDescriptors): Promise; - /** * Get output device for target audio renderer info. * @param { AudioRendererInfo } rendererInfo - Audio renderer information @@ -3641,21 +3710,6 @@ declare namespace audio { */ getPreferredOutputDeviceForRendererInfoSync(rendererInfo: AudioRendererInfo): AudioDeviceDescriptors; - /** - * Get the preferred output devices by the target audio renderer filter. - * @param { AudioRendererFilter } filter - Audio renderer filter. - * @returns { AudioDeviceDescriptors } The preferred devices. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Device - * @systemapi - * @since 18 - */ - getPreferredOutputDeviceByFilter(filter: AudioRendererFilter): AudioDeviceDescriptors; - /** * Subscribes to prefer output device change events. When prefer device for target audio renderer info changes, * registered clients will receive the callback. @@ -3766,21 +3820,6 @@ declare namespace audio { */ getPreferredInputDeviceForCapturerInfo(capturerInfo: AudioCapturerInfo): Promise; - /** - * Get the preferred input device for the target audio capturer filter. - * @param { AudioCapturerFilter } filter - Audio capturer filter. - * @returns { AudioDeviceDescriptors } The preferred devices. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Device - * @systemapi - * @since 18 - */ - getPreferredInputDeviceByFilter(filter: AudioCapturerFilter): AudioDeviceDescriptors; - /** * Subscribes to preferred input device change events. When preferred device for target audio capturer info changes, * registered clients will receive the callback. @@ -4166,19 +4205,7 @@ declare namespace audio { * @crossplatform * @since 12 */ - /** - * Unsubscribes to audio renderer change events. - * @param { 'audioRendererChange' } type - Type of the event to listen for. Only the audioRendererChange event is supported. - * @param { Callback } callback - Callback invoked for the audio renderer change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Renderer - * @crossplatform - * @since 18 - */ - off(type: 'audioRendererChange', callback?: Callback): void; + off(type: 'audioRendererChange'): void; /** * Listens for audio capturer change events. When there is any audio capturer change, @@ -4228,19 +4255,7 @@ declare namespace audio { * @crossplatform * @since 12 */ - /** - * Unsubscribes to audio capturer change events. - * @param { 'audioCapturerChange' } type - Type of the event to listen for. Only the audioCapturerChange event is supported. - * @param { Callback } callback - Callback invoked for the audio capturer change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Capturer - * @crossplatform - * @since 18 - */ - off(type: 'audioCapturerChange', callback?: Callback): void; + off(type: 'audioCapturerChange'): void; /** * Checks whether a stream is active. This method uses an asynchronous callback to return the query result. @@ -4309,35 +4324,40 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioConcurrencyMode { /** * Default concurrency mode. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONCURRENCY_DEFAULT = 0, /** * Mix with others mode. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONCURRENCY_MIX_WITH_OTHERS = 1, /** * Duck others mode. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONCURRENCY_DUCK_OTHERS = 2, /** * Pause others mode. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONCURRENCY_PAUSE_OTHERS = 3, } @@ -4347,21 +4367,24 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioSessionDeactivatedReason { /** * Lower priority. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEACTIVATED_LOWER_PRIORITY = 0, /** * Time out. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEACTIVATED_TIMEOUT = 1, } @@ -4485,7 +4508,8 @@ declare namespace audio { * @typedef AudioVolumeManager * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioVolumeManager { /** @@ -4577,109 +4601,6 @@ declare namespace audio { */ getVolumeGroupManagerSync(groupId: number): AudioVolumeGroupManager; - /** - * Get the volume for specified app with range from 0 to 100. Applications with same uid share the same volume. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - getAppVolumePercentageForUid(uid: number): Promise; - - /** - * Sets the volume for specified app with range from 0 to 100. Applications with same uid share the same volume. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @param { number } volume - Volume to set. The value range is from 0 to 100. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @throws { BusinessError } 6800301 - Crash or blocking occurs in system process. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - setAppVolumePercentageForUid(uid: number, volume: number): Promise; - - /** - * Checks whether the app volume is muted. If there are multiple callers setting muted states, - * only when all callers cancel muted state the volume of this app will be truly unmuted. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @param { boolean } owned - If true is passed, the result will be indicated your owned muted state - * settings to this app. Otherwise if false is passed, the result will be indicated the real muted state. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - isAppVolumeMutedForUid(uid: number, owned: boolean): Promise; - - /** - * Change mute state of specified application volume. If there are multiple callers setting muted states, - * only when all callers cancel muted state the volume of this app will be truly unmuted. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { number } uid - App's uid. - * @param { boolean } muted - Muted state to set. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @throws { BusinessError } 6800301 - Crash or blocking occurs in system process. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - setAppVolumeMutedForUid(uid: number, muted: boolean): Promise; - - /** - * Get the volume for your app with range from 0 to 100. Applications with the same uid share the same volume. - * @returns { Promise } The application's volume percentage. The value range is from 0 to 100. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - getAppVolumePercentage(): Promise; - - /** - * Sets the volume for your app with range from 0 to 100. Applications with the same uid share the same volume. - * Only AudioRenderers with {@link AudioRendererInfo.volumeMode} set to {@link AudioVolumeMode.APP_INDIVIDUAL} - * will be affected by this volume. - * When you change your app's volume, your will receive 'appVolumeChange' callback event. - * Your app volume can be also changed by other system settings, and you can monitor the changes through - * 'appVolumeChange' callback. - * @param { number } volume - Volume to set. The value range is from 0 to 100. - * @returns { Promise } Promise used to return the result. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @throws { BusinessError } 6800301 - Crash or blocking occurs in system process. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - setAppVolumePercentage(volume: number): Promise; - /** * Listens for system volume change events. This method uses a callback to get volume change events. * @param { 'volumeChange' } type - Type of the event to listen for. Only the volumeChange event is supported. @@ -4717,72 +4638,6 @@ declare namespace audio { * @since 12 */ off(type: 'volumeChange', callback?: Callback): void; - - /** - * Listens for specified app volume change events. - * The app volume may changed by {@link setAppVolumePercentageForUid}. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { 'appVolumeChangeForUid' } type - Type of the event to listen for. Only the - * appVolumeChangeForUid event is supported. - * @param { number } uid - The app's uid. - * @param { Callback } callback - Callback used to get the app volume change event. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - on(type: 'appVolumeChangeForUid', uid: number, callback: Callback): void; - - /** - * Unsubscribes to the app volume change events.. - * @permission ohos.permission.MANAGE_AUDIO_CONFIG - * @param { 'appVolumeChangeForUid' } type - Type of the event to be unregistered. Only the appVolumeChangeForUid - * event is supported. - * @param { Callback } callback - Callback used to obtain the invoking volume change event. - * @throws { BusinessError } 201 - Permission denied. - * @throws { BusinessError } 202 - Not system App. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @systemapi - * @since 18 - */ - off(type: 'appVolumeChangeForUid', callback?: Callback): void; - - /** - * Listens for app volume change events. The app volume may changed by your called {@link setAppVolumePercentage} - * or other system settings. - * @param { 'appVolumeChange' } type - Type of the event to listen for. Only the appVolumeChange event is supported. - * @param { Callback } callback - Callback used to get the app volume change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - on(type: 'appVolumeChange', callback: Callback): void; - - /** - * Unsubscribes to the app volume change events.. - * @param { 'appVolumeChange' } type - Type of the event to be unregistered. Only the appVolumeChange event - * is supported. - * @param { Callback } callback - Callback used to obtain the invoking volume change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified. - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - off(type: 'appVolumeChange', callback?: Callback): void; } /** @@ -5187,19 +5042,6 @@ declare namespace audio { */ on(type: 'ringerModeChange', callback: Callback): void; - /** - * Unsubscribes to the ringer mode state change events. - * @param { 'ringerModeChange' } type - Type of the event to listen for. - * @param { Callback } callback - Callback used to get the updated ringer mode. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - off(type: 'ringerModeChange', callback?: Callback): void; - /** * Mutes or unmutes the microphone. This method uses an asynchronous callback to return the result. * @permission ohos.permission.MANAGE_AUDIO_CONFIG @@ -6067,14 +5909,16 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum ConnectType { /** * Connect type for local device. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ CONNECT_TYPE_LOCAL = 1, @@ -6082,7 +5926,8 @@ declare namespace audio { * Connect type for distributed device. * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ CONNECT_TYPE_DISTRIBUTED = 2 } @@ -6092,7 +5937,8 @@ declare namespace audio { * @typedef VolumeGroupInfo * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface VolumeGroupInfo { /** @@ -6101,7 +5947,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly networkId: string; @@ -6111,7 +5958,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly groupId: number; @@ -6121,7 +5969,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly mappingId: number; @@ -6131,7 +5980,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly groupName: string; @@ -6141,7 +5991,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly type: ConnectType; } @@ -6151,7 +6002,8 @@ declare namespace audio { * @typedef { Array> } VolumeGroupInfos * @syscap SystemCapability.Multimedia.Audio.Volume * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ type VolumeGroupInfos = Array>; @@ -6166,7 +6018,8 @@ declare namespace audio { * @typedef { Array> } AudioRendererChangeInfoArray * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AudioRendererChangeInfoArray = Array>; @@ -6181,7 +6034,8 @@ declare namespace audio { * @typedef AudioRendererChangeInfo * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioRendererChangeInfo { /** @@ -6196,7 +6050,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly streamId: number; @@ -6206,7 +6061,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Renderer * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly clientUid: number; @@ -6222,7 +6078,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly rendererInfo: AudioRendererInfo; @@ -6232,7 +6089,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Renderer * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly rendererState: AudioState; @@ -6248,7 +6106,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Renderer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly deviceDescriptors: AudioDeviceDescriptors; } @@ -6264,7 +6123,8 @@ declare namespace audio { * @typedef { Array> } AudioCapturerChangeInfoArray * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AudioCapturerChangeInfoArray = Array>; @@ -6279,7 +6139,8 @@ declare namespace audio { * @typedef AudioCapturerChangeInfo * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioCapturerChangeInfo { /** @@ -6294,7 +6155,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly streamId: number; @@ -6304,7 +6166,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Capturer * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly clientUid: number; @@ -6320,7 +6183,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly capturerInfo: AudioCapturerInfo; @@ -6330,7 +6194,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Capturer * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly capturerState: AudioState; @@ -6346,7 +6211,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly deviceDescriptors: AudioDeviceDescriptors; @@ -6362,7 +6228,8 @@ declare namespace audio { * @readonly * @syscap SystemCapability.Multimedia.Audio.Capturer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly muted?: boolean; } @@ -6379,7 +6246,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioDeviceDescriptor { /** @@ -6395,7 +6263,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly deviceRole: DeviceRole; @@ -6412,7 +6281,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly deviceType: DeviceType; @@ -6611,31 +6481,11 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AudioDeviceDescriptors = Array>; - /** - * Volume mode. - * @enum { number } - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - enum AudioVolumeMode { - /** - * Audio volume affected by system volume level. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - SYSTEM_GLOBAL = 0, - /** - * Audio volume affected by app's individual percentage. - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - APP_INDIVIDUAL = 1 - } - /** * Describes the volume event received by the app when the volume is changed. * @typedef VolumeEvent @@ -6647,14 +6497,16 @@ declare namespace audio { * @typedef VolumeEvent * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface VolumeEvent { /** * Volume type of the current stream. * @type { AudioVolumeType } * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ volumeType: AudioVolumeType; /** @@ -6668,14 +6520,16 @@ declare namespace audio { * @type { number } * @syscap SystemCapability.Multimedia.Audio.Volume * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ volume: number; /** * Whether to show the volume change in UI. * @type { boolean } * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ updateUi: boolean; /** @@ -6694,13 +6548,6 @@ declare namespace audio { * @since 9 */ networkId: string; - /** - * Audio volume mode of this volume event - * @type { ?AudioVolumeMode } - * @syscap SystemCapability.Multimedia.Audio.Volume - * @since 18 - */ - volumeMode?: AudioVolumeMode; } /** @@ -6927,7 +6774,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioStreamDeviceChangeReason { /** @@ -6940,7 +6788,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REASON_UNKNOWN = 0, /** @@ -6953,7 +6802,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REASON_NEW_DEVICE_AVAILABLE = 1, /** @@ -6968,7 +6818,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REASON_OLD_DEVICE_UNAVAILABLE = 2, /** @@ -6981,7 +6832,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REASON_OVERRODE = 3, } @@ -6997,7 +6849,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioStreamDeviceChangeInfo { /** @@ -7012,7 +6865,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ devices: AudioDeviceDescriptors; /** @@ -7027,7 +6881,8 @@ declare namespace audio { * @syscap SystemCapability.Multimedia.Audio.Device * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ changeReason: AudioStreamDeviceChangeReason; } @@ -8083,19 +7938,6 @@ declare namespace audio { */ on(type: 'audioInterrupt', callback: Callback): void; - /** - * Unsubscribes audio interrupt events. - * @param { 'audioInterrupt' } type - Type of the event to listen for. - * @param { Callback } callback - Callback used to listen for interrupt callback. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Interrupt - * @since 18 - */ - off(type: 'audioInterrupt', callback?: Callback): void; - /** * Subscribes to mark reached events. When the number of frames rendered reaches the value of the frame parameter, * the callback is invoked. @@ -8129,15 +7971,7 @@ declare namespace audio { * @crossplatform * @since 12 */ - /** - * Unsubscribes from mark reached events. - * @param { 'markReach' } type - Type of the event to listen for. Only the markReach event is supported. - * @param { Callback } callback - Callback invoked when the event is triggered. - * @syscap SystemCapability.Multimedia.Audio.Renderer - * @crossplatform - * @since 18 - */ - off(type: 'markReach', callback?: Callback): void; + off(type: 'markReach'): void; /** * Subscribes to period reached events. When the period of frame rendering reaches the value of frame parameter, @@ -8172,15 +8006,7 @@ declare namespace audio { * @crossplatform * @since 12 */ - /** - * Unsubscribes from period reached events. - * @param { 'periodReach' } type - Type of the event to listen for. Only the periodReach event is supported. - * @param { Callback } callback - Callback invoked when the event is triggered. - * @syscap SystemCapability.Multimedia.Audio.Renderer - * @crossplatform - * @since 18 - */ - off(type: 'periodReach', callback?: Callback): void; + off(type: 'periodReach'): void; /** * Subscribes audio state change event callback. @@ -8199,19 +8025,6 @@ declare namespace audio { */ on(type: 'stateChange', callback: Callback): void; - /** - * Unsubscribes audio state change event callback. - * @param { 'stateChange' } type - Type of the event to listen for. - * @param { Callback } callback - Callback invoked when state change. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Renderer - * @since 18 - */ - off(type: 'stateChange', callback?: Callback): void; - /** * Subscribes output device change event callback. * The event is triggered when output device change for this stream. @@ -8380,13 +8193,15 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum SourceType { /** * Invalid source type. * @syscap SystemCapability.Multimedia.Audio.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_INVALID = -1, /** @@ -8398,7 +8213,8 @@ declare namespace audio { * Mic source type. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_MIC = 0, /** @@ -8410,7 +8226,8 @@ declare namespace audio { * Voice recognition source type. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_VOICE_RECOGNITION = 1, /** @@ -8426,7 +8243,8 @@ declare namespace audio { * Permission ohos.permission.MANAGE_INTELLIGENT_VOICE is needed when calling createAudioCapturer with this type. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_WAKEUP = 3, @@ -8435,7 +8253,8 @@ declare namespace audio { * Permission ohos.permission.RECORD_VOICE_CALL is needed when calling createAudioCapturer with this type. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_VOICE_CALL = 4, @@ -8448,14 +8267,16 @@ declare namespace audio { * Voice communication source type. * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_VOICE_COMMUNICATION = 7, /** * Voice message source type. * @syscap SystemCapability.Multimedia.Audio.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_VOICE_MESSAGE = 10, @@ -8463,21 +8284,24 @@ declare namespace audio { * Source type for voice transcription and processing. * @syscap SystemCapability.Multimedia.Audio.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_VOICE_TRANSCRIPTION = 12, /** * Camcorder source type. * @syscap SystemCapability.Multimedia.Audio.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_CAMCORDER = 13, /** * Unprocessed source type. * @syscap SystemCapability.Multimedia.Audio.Core - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_TYPE_UNPROCESSED = 14 } @@ -8493,7 +8317,8 @@ declare namespace audio { * @typedef AudioCapturerInfo * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AudioCapturerInfo { /** @@ -8507,7 +8332,8 @@ declare namespace audio { * @type { SourceType } * @syscap SystemCapability.Multimedia.Audio.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ source: SourceType; /** @@ -9097,15 +8923,7 @@ declare namespace audio { * @crossplatform * @since 12 */ - /** - * Unsubscribes from the mark reached events. - * @param { 'markReach' } type - Type of the event to listen for. Only the markReach event is supported. - * @param { Callback } callback - Callback invoked when the event is triggered. - * @syscap SystemCapability.Multimedia.Audio.Capturer - * @crossplatform - * @since 18 - */ - off(type: 'markReach', callback?: Callback): void; + off(type: 'markReach'): void; /** * Subscribes to period reached events. When the period of frame capturing reaches the value of frame parameter, @@ -9140,15 +8958,7 @@ declare namespace audio { * @crossplatform * @since 12 */ - /** - * Unsubscribes from period reached events. - * @param { 'periodReach' } type - Type of the event to listen for. Only the periodReach event is supported. - * @param { Callback } callback - Callback invoked when the event is triggered. - * @syscap SystemCapability.Multimedia.Audio.Capturer - * @crossplatform - * @since 18 - */ - off(type: 'periodReach', callback?: Callback): void; + off(type: 'periodReach'): void; /** * Subscribes audio state change event callback. @@ -9167,19 +8977,6 @@ declare namespace audio { */ on(type: 'stateChange', callback: Callback): void; - /** - * Unsubscribes audio state change event callback. - * @param { 'stateChange' } type - Type of the event to listen for. - * @param { Callback } callback - Callback used to listen for the audio state change event. - * @throws { BusinessError } 401 - Parameter error. Possible causes: - * 1.Mandatory parameters are left unspecified; - * 2.Incorrect parameter types. - * @throws { BusinessError } 6800101 - Parameter verification failed. - * @syscap SystemCapability.Multimedia.Audio.Capturer - * @since 18 - */ - off(type: 'stateChange', callback?: Callback): void; - /** * Listens for audio interrupt events. This method uses a callback to get interrupt events. The interrupt event is * triggered when audio recording is interrupted. @@ -9513,7 +9310,7 @@ declare namespace audio { * @systemapi * @since 12 */ - TTS_MUTE = 2, + TTS_MUTE = 2, /** * Mute the voice call stream. * @syscap SystemCapability.Multimedia.Audio.Capturer @@ -9997,7 +9794,8 @@ declare namespace audio { * Array of AudioEffectMode, which is read-only. * @typedef { Array> } AudioEffectInfoArray * @syscap SystemCapability.Multimedia.Audio.Renderer - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type AudioEffectInfoArray = Array>; @@ -10012,7 +9810,8 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Renderer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioEffectMode { /** @@ -10024,7 +9823,8 @@ declare namespace audio { * Audio Effect Mode effect none. * @syscap SystemCapability.Multimedia.Audio.Renderer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EFFECT_NONE = 0, /** @@ -10036,7 +9836,8 @@ declare namespace audio { * Audio Effect Mode effect default. * @syscap SystemCapability.Multimedia.Audio.Renderer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EFFECT_DEFAULT = 1, } @@ -10091,49 +9892,56 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioSpatialDeviceType { /** * Audio Spatial Device Type none. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_DEVICE_TYPE_NONE = 0, /** * Audio Spatial Device Type in-ear headphone. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_DEVICE_TYPE_IN_EAR_HEADPHONE = 1, /** * Audio Spatial Device Type half-in-ear headphone. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_DEVICE_TYPE_HALF_IN_EAR_HEADPHONE = 2, /** * Audio Spatial Device Type over-ear headphone. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_DEVICE_TYPE_OVER_EAR_HEADPHONE = 3, /** * Audio Spatial Device Type glasses. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_DEVICE_TYPE_GLASSES = 4, /** * Audio Spatial Device Type others. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_DEVICE_TYPE_OTHERS = 5, } @@ -10143,35 +9951,40 @@ declare namespace audio { * @enum { number } * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioSpatializationSceneType { /** * Audio Spatialization Scene Type Default. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, /** * Audio Spatialization Scene Type Music. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MUSIC = 1, /** * Audio Spatialization Scene Type Movie. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MOVIE = 2, /** * Audio Spatialization Scene Type Audio Book. * @syscap SystemCapability.Multimedia.Audio.Spatialization * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIOBOOK = 3, } diff --git a/api/@ohos.multimedia.avCastPickerParam.d.ts b/api/@ohos.multimedia.avCastPickerParam.d.ts index a98cb428214a67662a4b1f3e3950546f49e48549..6cc41b8d704c73741bee186035f24e886621c172 100644 --- a/api/@ohos.multimedia.avCastPickerParam.d.ts +++ b/api/@ohos.multimedia.avCastPickerParam.d.ts @@ -29,7 +29,8 @@ * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum AVCastPickerState { /** @@ -64,7 +65,8 @@ export declare enum AVCastPickerState { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum AVCastPickerStyle { /** @@ -89,7 +91,8 @@ export declare enum AVCastPickerStyle { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum AVCastPickerColorMode { /** diff --git a/api/@ohos.multimedia.avInputCastPicker.d.ets b/api/@ohos.multimedia.avInputCastPicker.d.ets index caadd4dbddeecc1e74d6c7760db3973aef8b3033..cdeba2381c042bc7f5239dd71dd8376a2d289639 100644 --- a/api/@ohos.multimedia.avInputCastPicker.d.ets +++ b/api/@ohos.multimedia.avInputCastPicker.d.ets @@ -25,7 +25,7 @@ import { AVCastPickerState } from './@ohos.multimedia.avCastPickerParam'; * @struct { AVInputCastPicker } * @syscap SystemCapability.Multimedia.AVSession.AVInputCast * @atomicservice - * @since 18 + * @since 20 */ @Component export declare struct AVInputCastPicker { @@ -36,7 +36,7 @@ export declare struct AVInputCastPicker { * @type { ? CustomBuilder } * @syscap SystemCapability.Multimedia.AVSession.AVInputCast * @atomicservice - * @since 18 + * @since 20 */ @Prop customPicker?: CustomBuilder; @@ -46,7 +46,7 @@ export declare struct AVInputCastPicker { * @type { ?OnPickerStateCallback } * @syscap SystemCapability.Multimedia.AVSession.AVInputCast * @atomicservice - * @since 18 + * @since 20 */ onStateChange?: OnPickerStateCallback; } @@ -59,6 +59,6 @@ export declare struct AVInputCastPicker { * @returns { void } * @syscap SystemCapability.Multimedia.AVSession.AVInputCast * @atomicservice - * @since 18 + * @since 20 */ export type OnPickerStateCallback = (state: AVCastPickerState) => void; \ No newline at end of file diff --git a/api/@ohos.multimedia.avsession.d.ts b/api/@ohos.multimedia.avsession.d.ts index dc87a72b457ece2ace2b665b6adf4296571fe9ef..18cb8636764d230cce7d961b34f25918bc77d49d 100644 --- a/api/@ohos.multimedia.avsession.d.ts +++ b/api/@ohos.multimedia.avsession.d.ts @@ -19,7 +19,7 @@ */ import type { ErrorCallback, AsyncCallback, Callback } from './@ohos.base'; -import { WantAgent } from './@ohos.wantAgent'; +import { WantAgent } from './@ohos.app.ability.wantAgent'; import { KeyEvent } from './@ohos.multimodalInput.keyEvent'; import { ElementName } from './bundleManager/ElementName'; import image from './@ohos.multimedia.image'; @@ -38,7 +38,8 @@ import type hdrCapability from './@ohos.graphics.hdrCapability'; * @namespace avSession * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace avSession { @@ -52,7 +53,8 @@ declare namespace avSession { * 2.Parameter verification failed. * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVSession(context: Context, tag: string, type: AVSessionType, callback: AsyncCallback): void; @@ -79,7 +81,8 @@ declare namespace avSession { * @throws { BusinessError } 6600101 - Session service exception. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVSession(context: Context, tag: string, type: AVSessionType): Promise; @@ -980,7 +983,8 @@ declare namespace avSession { * @typedef { 'audio' | 'video' | 'voice_call' | 'video_call' } AVSessionType * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AVSessionType = 'audio' | 'video' | 'voice_call' | 'video_call'; @@ -995,7 +999,8 @@ declare namespace avSession { * @interface AVSession * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVSession { /** @@ -1009,7 +1014,8 @@ declare namespace avSession { * @readonly * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly sessionId: string; @@ -1025,7 +1031,8 @@ declare namespace avSession { * @readonly * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly sessionType: AVSessionType; @@ -1469,7 +1476,8 @@ declare namespace avSession { * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getAllCastDisplays(): Promise>; @@ -2553,7 +2561,8 @@ declare namespace avSession { * @throws { BusinessError } 6600102 - The session does not exist * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'castDisplayChange', callback: Callback): void; @@ -2603,7 +2612,8 @@ declare namespace avSession { * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ activate(callback: AsyncCallback): void; @@ -2622,7 +2632,8 @@ declare namespace avSession { * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ activate(): Promise; @@ -2661,7 +2672,8 @@ declare namespace avSession { * @throws { BusinessError } 6600101 - Session service exception. * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ destroy(callback: AsyncCallback): void; @@ -2680,7 +2692,8 @@ declare namespace avSession { * @throws { BusinessError } 6600102 - The session does not exist. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ destroy(): Promise; } @@ -2698,7 +2711,8 @@ declare namespace avSession { * 'setVolume' | 'setSpeed' | 'setLoopMode' | 'toggleFavorite' | 'toggleMute' } AVCastControlCommandType * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AVCastControlCommandType = 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward' | 'rewind' | 'seek' | 'setVolume' | 'setSpeed' | 'setLoopMode' | 'toggleFavorite' | 'toggleMute'; @@ -3795,7 +3809,8 @@ declare namespace avSession { * @param { Uint8Array } requestData - media key request data sent to media key server * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type KeyRequestCallback = (assetId: string, requestData: Uint8Array) => void; @@ -3805,7 +3820,8 @@ declare namespace avSession { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum CastDisplayState { /** @@ -3813,7 +3829,8 @@ declare namespace avSession { * * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_OFF = 1, @@ -3822,7 +3839,8 @@ declare namespace avSession { * * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_ON = 2, } @@ -3832,7 +3850,8 @@ declare namespace avSession { * @typedef CastDisplayInfo * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface CastDisplayInfo { /** @@ -3841,7 +3860,8 @@ declare namespace avSession { * @type { number } * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -3850,7 +3870,8 @@ declare namespace avSession { * @type { string } * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -3859,7 +3880,8 @@ declare namespace avSession { * @type { CastDisplayState } * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ state: CastDisplayState; @@ -3868,7 +3890,8 @@ declare namespace avSession { * @type { number } * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -3877,7 +3900,8 @@ declare namespace avSession { * @type { number } * @syscap SystemCapability.Multimedia.AVSession.ExtendedDisplayCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -4316,7 +4340,7 @@ declare namespace avSession { * @type { ?string } * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 18 + * @since 17 */ singleLyricText?: string; @@ -5147,7 +5171,8 @@ declare namespace avSession { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum CallState { /** @@ -5159,7 +5184,8 @@ declare namespace avSession { * Idle state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_IDLE = 0, @@ -5172,7 +5198,8 @@ declare namespace avSession { * Incoming state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_INCOMING = 1, @@ -5185,7 +5212,8 @@ declare namespace avSession { * Active state in calling. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_ACTIVE = 2, @@ -5198,7 +5226,8 @@ declare namespace avSession { * Dialing state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_DIALING = 3, @@ -5211,7 +5240,8 @@ declare namespace avSession { * Waiting state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_WAITING = 4, @@ -5224,7 +5254,8 @@ declare namespace avSession { * Holding state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_HOLDING = 5, @@ -5237,7 +5268,8 @@ declare namespace avSession { * Disconnecting state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CALL_STATE_DISCONNECTING = 6, } @@ -5253,7 +5285,8 @@ declare namespace avSession { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AVCastCategory { /** @@ -5267,7 +5300,8 @@ declare namespace avSession { * including internal speakers or audio jack on the device itself, A2DP devices. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CATEGORY_LOCAL = 0, @@ -5282,7 +5316,8 @@ declare namespace avSession { * the application needs to get an AVCastController to control remote playback. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CATEGORY_REMOTE = 1, } @@ -5297,7 +5332,8 @@ declare namespace avSession { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeviceType { /** @@ -5309,7 +5345,8 @@ declare namespace avSession { * A device type indicating the route is on internal speakers or audio jack on the device itself. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEVICE_TYPE_LOCAL = 0, @@ -5322,7 +5359,8 @@ declare namespace avSession { * A device type indicating the route is on a TV. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEVICE_TYPE_TV = 2, @@ -5335,7 +5373,8 @@ declare namespace avSession { * A device type indicating the route is on a smart speaker. * @syscap SystemCapability.Multimedia.AVSession.AVCast * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEVICE_TYPE_SMART_SPEAKER = 3, @@ -5348,7 +5387,8 @@ declare namespace avSession { * A device type indicating the route is on a bluetooth device. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEVICE_TYPE_BLUETOOTH = 10, } @@ -5572,7 +5612,8 @@ declare namespace avSession { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum LoopMode { /** @@ -5584,7 +5625,8 @@ declare namespace avSession { * The default mode is sequential playback * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOOP_MODE_SEQUENCE = 0, @@ -5597,7 +5639,8 @@ declare namespace avSession { * Single loop mode * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOOP_MODE_SINGLE = 1, @@ -5610,7 +5653,8 @@ declare namespace avSession { * List loop mode * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOOP_MODE_LIST = 2, @@ -5623,7 +5667,8 @@ declare namespace avSession { * Shuffle playback mode * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOOP_MODE_SHUFFLE = 3, @@ -5636,7 +5681,8 @@ declare namespace avSession { * Custom playback mode supported by application * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOOP_MODE_CUSTOM = 4, } @@ -5645,25 +5691,29 @@ declare namespace avSession { * Supported skip intervals definition * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum SkipIntervals { /** * 10 seconds * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SECONDS_10 = 10, /** * 15 seconds * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SECONDS_15 = 15, /** * 30 seconds * @syscap SystemCapability.Multimedia.AVSession.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SECONDS_30 = 30, } @@ -5679,7 +5729,8 @@ declare namespace avSession { * @enum { number } * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PlaybackState { /** @@ -5691,7 +5742,8 @@ declare namespace avSession { * Initial state. The initial state of media file * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_INITIAL = 0, @@ -5706,7 +5758,8 @@ declare namespace avSession { * the media is loading or buffering * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_PREPARE = 1, @@ -5719,7 +5772,8 @@ declare namespace avSession { * Playing state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_PLAY = 2, @@ -5732,7 +5786,8 @@ declare namespace avSession { * Paused state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_PAUSE = 3, @@ -5745,7 +5800,8 @@ declare namespace avSession { * Fast forwarding state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_FAST_FORWARD = 4, @@ -5758,7 +5814,8 @@ declare namespace avSession { * Rewinding state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_REWIND = 5, @@ -5771,7 +5828,8 @@ declare namespace avSession { * Stopped state.The server will clear the media playback position and other information. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_STOP = 6, @@ -5784,7 +5842,8 @@ declare namespace avSession { * Completed state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_COMPLETED = 7, @@ -5797,7 +5856,8 @@ declare namespace avSession { * Released state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_RELEASED = 8, @@ -5810,7 +5870,8 @@ declare namespace avSession { * error state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_ERROR = 9, @@ -5823,7 +5884,8 @@ declare namespace avSession { * Idle state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_IDLE = 10, @@ -5836,7 +5898,8 @@ declare namespace avSession { * Buffering state. * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLAYBACK_STATE_BUFFERING = 11, } @@ -7378,7 +7441,8 @@ declare namespace avSession { * 'toggleCallMute' } AVControlCommandType * @syscap SystemCapability.Multimedia.AVSession.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AVControlCommandType = 'play' | 'pause' | 'stop' | 'playNext' | 'playPrevious' | 'fastForward' | 'rewind' | 'seek' | 'setSpeed' | 'setLoopMode' | 'toggleFavorite' | 'playFromAssetId' | 'answer' | 'hangUp' | 'toggleCallMute'; diff --git a/api/@ohos.multimedia.camera.d.ts b/api/@ohos.multimedia.camera.d.ts index 24e430b4c868c80b1dfc0523ccae60264fddc0c7..12a3abe04f1e8a7dbcc35a3f558ac1be88935818 100644 --- a/api/@ohos.multimedia.camera.d.ts +++ b/api/@ohos.multimedia.camera.d.ts @@ -33,7 +33,8 @@ import photoAccessHelper from './@ohos.file.photoAccessHelper'; * @namespace camera * @syscap SystemCapability.Multimedia.Camera.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace camera { /** @@ -44,7 +45,8 @@ declare namespace camera { * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. * @throws { BusinessError } 7400201 - Camera service fatal error. * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getCameraManager(context: Context): CameraManager; @@ -53,14 +55,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum CameraStatus { /** * Appear status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_STATUS_APPEAR = 0, @@ -68,7 +72,8 @@ declare namespace camera { * Disappear status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_STATUS_DISAPPEAR = 1, @@ -76,7 +81,8 @@ declare namespace camera { * Available status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_STATUS_AVAILABLE = 2, @@ -84,7 +90,8 @@ declare namespace camera { * Unavailable status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_STATUS_UNAVAILABLE = 3 } @@ -94,14 +101,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum FoldStatus { /** * Non-foldable status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NON_FOLDABLE = 0, @@ -109,7 +118,8 @@ declare namespace camera { * Expanded status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPANDED = 1, @@ -117,7 +127,8 @@ declare namespace camera { * Folded status. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOLDED = 2 } @@ -381,7 +392,8 @@ declare namespace camera { * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum RestoreParamType { /** @@ -389,7 +401,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NO_NEED_RESTORE_PARAM = 0, @@ -398,7 +411,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRESISTENT_DEFAULT_PARAM = 1, @@ -407,7 +421,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TRANSIENT_ACTIVE_PARAM = 2 } @@ -418,7 +433,8 @@ declare namespace camera { * @typedef SettingParam * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SettingParam { /** @@ -427,7 +443,8 @@ declare namespace camera { * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ skinSmoothLevel: number; @@ -437,7 +454,8 @@ declare namespace camera { * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ faceSlender: number; @@ -447,7 +465,8 @@ declare namespace camera { * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ skinTone: number; } @@ -507,7 +526,8 @@ declare namespace camera { * * @interface CameraManager * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface CameraManager { /** @@ -598,9 +618,9 @@ declare namespace camera { * @permission ohos.camera.CAMERA_CONTROL * @param { boolean } mute - Mute camera if TRUE, otherwise unmute camera. * @param { PolicyType } type - Type for indicating the calling role. - * @throws { BusinessError } 201 - Permission denied. + * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi * @since 12 @@ -982,7 +1002,8 @@ declare namespace camera { * @throws { BusinessError } 202 - Not System Application. * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ prelaunch(): void; @@ -1148,14 +1169,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum TorchMode { /** * The device torch is always off. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OFF = 0, @@ -1163,7 +1186,8 @@ declare namespace camera { * The device torch is always on. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ON = 1, @@ -1171,7 +1195,8 @@ declare namespace camera { * The device continuously monitors light levels and uses the torch when necessary. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 2 } @@ -1245,7 +1270,8 @@ declare namespace camera { * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum CameraPosition { /** @@ -1259,7 +1285,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_POSITION_UNSPECIFIED = 0, @@ -1274,7 +1301,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_POSITION_BACK = 1, @@ -1289,7 +1317,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_POSITION_FRONT = 2, @@ -1315,14 +1344,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum CameraType { /** * Default camera type * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_TYPE_DEFAULT = 0, @@ -1330,7 +1361,8 @@ declare namespace camera { * Wide camera * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_TYPE_WIDE_ANGLE = 1, @@ -1338,7 +1370,8 @@ declare namespace camera { * Ultra wide camera * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_TYPE_ULTRA_WIDE = 2, @@ -1346,7 +1379,8 @@ declare namespace camera { * Telephoto camera * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_TYPE_TELEPHOTO = 3, @@ -1354,7 +1388,8 @@ declare namespace camera { * True depth camera * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_TYPE_TRUE_DEPTH = 4 } @@ -1364,14 +1399,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum ConnectionType { /** * Built-in camera. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_CONNECTION_BUILT_IN = 0, @@ -1379,7 +1416,8 @@ declare namespace camera { * Camera connected using USB * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_CONNECTION_USB_PLUGIN = 1, @@ -1387,7 +1425,8 @@ declare namespace camera { * Remote camera * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_CONNECTION_REMOTE = 2 } @@ -1405,7 +1444,8 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ enum HostDeviceType { /** @@ -1419,7 +1459,8 @@ declare namespace camera { * Indicates an unknown device camera. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN_TYPE = 0, @@ -1434,7 +1475,8 @@ declare namespace camera { * Indicates a smartphone camera. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ PHONE = 0x0E, @@ -1449,7 +1491,8 @@ declare namespace camera { * Indicates a tablet camera. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ TABLET = 0x11 } @@ -1567,7 +1610,8 @@ declare namespace camera { * * @typedef Size * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface Size { /** @@ -1575,7 +1619,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -1584,7 +1629,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; } @@ -1594,7 +1640,8 @@ declare namespace camera { * * @typedef Point * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface Point { /** @@ -1602,7 +1649,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -1611,7 +1659,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -1729,7 +1778,7 @@ declare namespace camera { * @since 12 */ on(type: 'cameraOcclusionDetection', callback: AsyncCallback): void; - + /** * Unsubscribes from camera occlusion detection results. * @@ -1764,14 +1813,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum SceneMode { /** * Normal photo mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL_PHOTO = 1, @@ -1779,7 +1830,8 @@ declare namespace camera { * Normal video mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL_VIDEO = 2, @@ -1788,7 +1840,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PORTRAIT_PHOTO = 3, @@ -1797,7 +1850,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NIGHT_PHOTO = 4, @@ -1806,7 +1860,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PROFESSIONAL_PHOTO = 5, @@ -1815,7 +1870,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PROFESSIONAL_VIDEO = 6, @@ -1824,7 +1880,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SLOW_MOTION_VIDEO = 7, @@ -1833,7 +1890,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MACRO_PHOTO = 8, @@ -1842,7 +1900,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MACRO_VIDEO = 9, @@ -1851,7 +1910,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHT_PAINTING_PHOTO = 10, @@ -1860,7 +1920,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH_RESOLUTION_PHOTO = 11, @@ -1868,7 +1929,8 @@ declare namespace camera { * Secure camera mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SECURE_PHOTO = 12, @@ -1877,7 +1939,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ QUICK_SHOT_PHOTO = 13, @@ -1886,7 +1949,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ APERTURE_VIDEO = 14, @@ -1895,7 +1959,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PANORAMA_PHOTO = 15, @@ -1904,7 +1969,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TIME_LAPSE_PHOTO = 16, @@ -1913,7 +1979,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ FLUORESCENCE_PHOTO = 17 } @@ -1923,14 +1990,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum CameraFormat { /** * RGBA 8888 Format. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_RGBA_8888 = 3, @@ -1939,7 +2008,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_DNG = 4, @@ -1947,7 +2017,8 @@ declare namespace camera { * YUV 420 Format. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_YUV_420_SP = 1003, @@ -1955,7 +2026,8 @@ declare namespace camera { * JPEG Format. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_JPEG = 2000, @@ -1963,7 +2035,8 @@ declare namespace camera { * YCBCR P010 Format. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_YCBCR_P010, @@ -1971,7 +2044,8 @@ declare namespace camera { * YCRCB P010 Format. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_YCRCB_P010, @@ -1979,7 +2053,8 @@ declare namespace camera { * HEIC Format. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_HEIC = 2003, @@ -1988,7 +2063,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_DEPTH_16 = 3000, @@ -1997,7 +2073,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_FORMAT_DEPTH_32 = 3001 } @@ -2007,14 +2084,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum FlashMode { /** * Close mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FLASH_MODE_CLOSE = 0, @@ -2022,7 +2101,8 @@ declare namespace camera { * Open mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FLASH_MODE_OPEN = 1, @@ -2030,7 +2110,8 @@ declare namespace camera { * Auto mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FLASH_MODE_AUTO = 2, @@ -2038,7 +2119,8 @@ declare namespace camera { * Always open mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FLASH_MODE_ALWAYS_OPEN = 3 } @@ -2183,14 +2265,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum ExposureMode { /** * Lock exposure mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_MODE_LOCKED = 0, @@ -2198,7 +2282,8 @@ declare namespace camera { * Auto exposure mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_MODE_AUTO = 1, @@ -2206,7 +2291,8 @@ declare namespace camera { * Continuous automatic exposure. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_MODE_CONTINUOUS_AUTO = 2, @@ -2215,7 +2301,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_MODE_MANUAL = 3 } @@ -2439,14 +2526,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum FocusMode { /** * Manual mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_MODE_MANUAL = 0, @@ -2454,7 +2543,8 @@ declare namespace camera { * Continuous auto mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_MODE_CONTINUOUS_AUTO = 1, @@ -2462,7 +2552,8 @@ declare namespace camera { * Auto mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_MODE_AUTO = 2, @@ -2470,7 +2561,8 @@ declare namespace camera { * Locked mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_MODE_LOCKED = 3 } @@ -2480,14 +2572,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum FocusState { /** * Scan state. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_STATE_SCAN = 0, @@ -2495,7 +2589,8 @@ declare namespace camera { * Focused state. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_STATE_FOCUSED = 1, @@ -2503,7 +2598,8 @@ declare namespace camera { * Unfocused state. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_STATE_UNFOCUSED = 2 } @@ -3215,7 +3311,7 @@ declare namespace camera { /** * Zoom object. * - * extends ZoomQuery + * @extends ZoomQuery * @interface Zoom * @syscap SystemCapability.Multimedia.Camera.Core * @since 11 @@ -3289,14 +3385,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoStabilizationMode { /** * Turn off video stablization. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ OFF = 0, @@ -3304,7 +3402,8 @@ declare namespace camera { * LOW mode provides basic stabilization effect. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ LOW = 1, @@ -3312,7 +3411,8 @@ declare namespace camera { * MIDDLE mode means algorithms can achieve better effects than LOW mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE = 2, @@ -3320,7 +3420,8 @@ declare namespace camera { * HIGH mode means algorithms can achieve better effects than MIDDLE mode. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH = 3, @@ -3328,7 +3429,8 @@ declare namespace camera { * Camera HDF can select mode automatically. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 4 } @@ -3436,7 +3538,8 @@ declare namespace camera { * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum BeautyType { /** @@ -3444,7 +3547,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -3453,7 +3557,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SKIN_SMOOTH = 1, @@ -3462,7 +3567,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_SLENDER = 2, @@ -3471,7 +3577,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SKIN_TONE = 3 } @@ -4893,7 +5000,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_720P = 0, - + /** * 1080P output for preconfig. * @@ -4901,7 +5008,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_1080P = 1, - + /** * 4K output for preconfig. * @@ -4909,7 +5016,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_4K = 2, - + /** * high quality output for preconfig. * @@ -4934,7 +5041,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_RATIO_1_1 = 0, - + /** * Aspect ratio 4:3 for preconfig. * @@ -4942,7 +5049,7 @@ declare namespace camera { * @since 12 */ PRECONFIG_RATIO_4_3 = 1, - + /** * Aspect ratio 16:9 for preconfig. * @@ -7106,7 +7213,7 @@ declare namespace camera { * High resolution session object. * * @extends Session, AutoExposure, Focus - * @interface HighResolutionPhotoSession + * @interface HighResolutionPhotoSession * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi * @since 12 @@ -7868,7 +7975,8 @@ declare namespace camera { * @typedef SketchStatusData * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SketchStatusData { /** @@ -7878,7 +7986,8 @@ declare namespace camera { * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ status: number; @@ -7888,7 +7997,8 @@ declare namespace camera { * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ sketchRatio: number; } @@ -8039,6 +8149,7 @@ declare namespace camera { getActiveFrameRate(): FrameRateRange; /** + * Gets the current preconfig type if you had already call preconfig interface. * * @returns { Profile } The current preconfig type. * @throws { BusinessError } 7400201 - Camera service fatal error. @@ -8274,14 +8385,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum ImageRotation { /** * The capture image rotates 0 degrees. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_0 = 0, @@ -8289,7 +8402,8 @@ declare namespace camera { * The capture image rotates 90 degrees. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_90 = 90, @@ -8297,7 +8411,8 @@ declare namespace camera { * The capture image rotates 180 degrees. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_180 = 180, @@ -8305,7 +8420,8 @@ declare namespace camera { * The capture image rotates 270 degrees. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ROTATION_270 = 270 } @@ -8315,7 +8431,8 @@ declare namespace camera { * * @typedef Location * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface Location { /** @@ -8323,7 +8440,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ latitude: number; @@ -8332,7 +8450,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ longitude: number; @@ -8341,7 +8460,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ altitude: number; } @@ -8351,14 +8471,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum QualityLevel { /** * High image quality. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_LEVEL_HIGH = 0, @@ -8366,7 +8488,8 @@ declare namespace camera { * Medium image quality. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_LEVEL_MEDIUM = 1, @@ -8374,7 +8497,8 @@ declare namespace camera { * Low image quality. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_LEVEL_LOW = 2 } @@ -8384,7 +8508,8 @@ declare namespace camera { * * @typedef PhotoCaptureSetting * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PhotoCaptureSetting { /** @@ -8392,7 +8517,8 @@ declare namespace camera { * * @type { ?QualityLevel } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ quality?: QualityLevel; @@ -8401,7 +8527,8 @@ declare namespace camera { * * @type { ?ImageRotation } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ rotation?: ImageRotation; @@ -8410,7 +8537,8 @@ declare namespace camera { * * @type { ?Location } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ location?: Location; @@ -8419,7 +8547,8 @@ declare namespace camera { * * @type { ?boolean } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ mirror?: boolean; } @@ -8430,7 +8559,8 @@ declare namespace camera { * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum DeferredDeliveryImageType { /** @@ -8438,7 +8568,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -8447,7 +8578,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTO = 1, @@ -8456,7 +8588,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO = 2 } @@ -8545,14 +8678,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoCodecType { /** * Codec type AVC. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ AVC = 0, @@ -8560,7 +8695,8 @@ declare namespace camera { * Codec type HEVC. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ HEVC = 1 } @@ -9257,7 +9393,8 @@ declare namespace camera { * * @typedef FrameShutterInfo * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface FrameShutterInfo { /** @@ -9265,7 +9402,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ captureId: number; /** @@ -9273,7 +9411,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ timestamp: number; } @@ -9283,7 +9422,8 @@ declare namespace camera { * * @typedef FrameShutterEndInfo * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface FrameShutterEndInfo { /** @@ -9291,7 +9431,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ captureId: number; } @@ -9301,7 +9442,8 @@ declare namespace camera { * * @typedef CaptureStartInfo * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface CaptureStartInfo { /** @@ -9309,7 +9451,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ captureId: number; /** @@ -9317,7 +9460,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ time: number; } @@ -9327,7 +9471,8 @@ declare namespace camera { * * @typedef CaptureEndInfo * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface CaptureEndInfo { /** @@ -9335,7 +9480,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ captureId: number; /** @@ -9343,7 +9489,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ frameCount: number; } @@ -9382,7 +9529,7 @@ declare namespace camera { /** * Video output object. * - * extends CameraOutput + * @extends CameraOutput * @interface VideoOutput * @syscap SystemCapability.Multimedia.Camera.Core * @since 10 @@ -9747,14 +9894,16 @@ declare namespace camera { * * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum MetadataObjectType { /** * Face detection type. * * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_DETECTION = 0, @@ -9763,7 +9912,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ HUMAN_BODY = 1, @@ -9772,7 +9922,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CAT_FACE = 2, @@ -9781,7 +9932,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ CAT_BODY = 3, @@ -9790,7 +9942,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DOG_FACE = 4, @@ -9799,7 +9952,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DOG_BODY = 5, @@ -9808,7 +9962,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ SALIENT_DETECTION = 6, @@ -9817,7 +9972,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ BAR_CODE_DETECTION = 7 } @@ -9873,7 +10029,8 @@ declare namespace camera { * * @typedef Rect * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface Rect { /** @@ -9881,7 +10038,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ topLeftX: number; /** @@ -9889,7 +10047,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ topLeftY: number; /** @@ -9897,7 +10056,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; /** @@ -9905,7 +10065,8 @@ declare namespace camera { * * @type { number } * @syscap SystemCapability.Multimedia.Camera.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -10262,7 +10423,7 @@ declare namespace camera { /** * Metadata Output object * - * extends CameraOutput + * @extends CameraOutput * @interface MetadataOutput * @syscap SystemCapability.Multimedia.Camera.Core * @since 10 @@ -10313,7 +10474,7 @@ declare namespace camera { * * @param { Array } types - Object types to be added. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. * @throws { BusinessError } 7400103 - Session not config. * @throws { BusinessError } 7400201 - Camera service fatal error. * @syscap SystemCapability.Multimedia.Camera.Core @@ -10327,7 +10488,7 @@ declare namespace camera { * * @param { Array } types - Object types to be removed. * @throws { BusinessError } 202 - Not System Application. - * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. + * @throws { BusinessError } 7400101 - Parameter missing or parameter type incorrect. * @throws { BusinessError } 7400103 - Session not config. * @throws { BusinessError } 7400201 - Camera service fatal error. * @syscap SystemCapability.Multimedia.Camera.Core @@ -10771,7 +10932,8 @@ declare namespace camera { * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum DepthDataAccuracy { /** @@ -10779,7 +10941,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DEPTH_DATA_ACCURACY_RELATIVE = 0, @@ -10788,7 +10951,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DEPTH_DATA_ACCURACY_ABSOLUTE = 1 } @@ -10799,7 +10963,8 @@ declare namespace camera { * @enum { number } * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum DepthDataQualityLevel { /** @@ -10807,7 +10972,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DEPTH_DATA_QUALITY_BAD = 0, @@ -10816,7 +10982,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DEPTH_DATA_QUALITY_FAIR = 1, @@ -10825,7 +10992,8 @@ declare namespace camera { * * @syscap SystemCapability.Multimedia.Camera.Core * @systemapi - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ DEPTH_DATA_QUALITY_GOOD = 2 } diff --git a/api/@ohos.multimedia.drm.d.ts b/api/@ohos.multimedia.drm.d.ts index e58565cb8dd7bd35e0d1ed7871ee160fa9fa523e..5c7542a742590fe1c3637e4406584c7592e74239 100644 --- a/api/@ohos.multimedia.drm.d.ts +++ b/api/@ohos.multimedia.drm.d.ts @@ -29,7 +29,8 @@ * @namespace drm * @syscap SystemCapability.Multimedia.Drm.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace drm { /** diff --git a/api/@ohos.multimedia.image.d.ts b/api/@ohos.multimedia.image.d.ts index f6046d0e78d9345d8485315bd773d68aa372aa48..8d12a3fcd67ecb0bebac06ab558857b0951ebcf1 100644 --- a/api/@ohos.multimedia.image.d.ts +++ b/api/@ohos.multimedia.image.d.ts @@ -22,6 +22,9 @@ import { AsyncCallback } from './@ohos.base'; import type colorSpaceManager from './@ohos.graphics.colorSpaceManager'; import type resourceManager from './@ohos.resourceManager'; import type rpc from './@ohos.rpc'; +/*** if arkts 1.1 */ +import { int, double, float } from './@ohos.base'; +/*** endif */ /** * @namespace image @@ -42,7 +45,8 @@ import type rpc from './@ohos.rpc'; * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace image { /** @@ -77,7 +81,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PixelMapFormat { /** @@ -108,7 +113,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, @@ -117,7 +123,8 @@ declare namespace image { * and are stored from the higher-order to the lower-order bits. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ARGB_8888 = 1, @@ -157,7 +164,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RGB_565 = 2, @@ -193,7 +201,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RGBA_8888 = 3, @@ -229,7 +238,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BGRA_8888 = 4, @@ -265,7 +275,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RGB_888 = 5, @@ -301,7 +312,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALPHA_8 = 6, @@ -337,7 +349,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RGBA_F16 = 7, @@ -373,7 +386,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NV21 = 8, @@ -409,7 +423,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NV12 = 9, @@ -418,7 +433,8 @@ declare namespace image { * R(10bits), G(10bits), B(10bits), A(2bits) and are stored from the higher-order to the lower-order bits. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RGBA_1010102 = 10, @@ -427,7 +443,8 @@ declare namespace image { * and are stored from the higher-order to the lower-order bits. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ YCBCR_P010 = 11, @@ -436,7 +453,8 @@ declare namespace image { * and are stored from the higher-order to the lower-order bits. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ YCRCB_P010 = 12, @@ -446,7 +464,8 @@ declare namespace image { * processing editing. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ ASTC_4x4 = 102 } @@ -457,7 +476,8 @@ declare namespace image { * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum ResolutionQuality { /** @@ -465,7 +485,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LOW = 1, @@ -474,7 +495,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIUM = 2, @@ -483,7 +505,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH = 3 } @@ -520,7 +543,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface Size { /** @@ -550,14 +574,15 @@ declare namespace image { /** * Height * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - height: number; + height: int; /** * Width @@ -586,14 +611,15 @@ declare namespace image { /** * Width * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - width: number; + width: int; } /** @@ -609,7 +635,8 @@ declare namespace image { * @enum { string } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ enum PropertyKey { /** @@ -623,7 +650,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ BITS_PER_SAMPLE = 'BitsPerSample', @@ -638,7 +666,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION = 'Orientation', @@ -653,7 +682,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_LENGTH = 'ImageLength', @@ -668,7 +698,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_WIDTH = 'ImageWidth', @@ -683,7 +714,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_LATITUDE = 'GPSLatitude', @@ -698,7 +730,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_LONGITUDE = 'GPSLongitude', @@ -713,7 +746,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_LATITUDE_REF = 'GPSLatitudeRef', @@ -728,7 +762,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_LONGITUDE_REF = 'GPSLongitudeRef', @@ -743,7 +778,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TIME_ORIGINAL = 'DateTimeOriginal', @@ -758,7 +794,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_TIME = 'ExposureTime', @@ -773,7 +810,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_TYPE = 'SceneType', @@ -788,7 +826,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ISO_SPEED_RATINGS = 'ISOSpeedRatings', @@ -803,7 +842,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ F_NUMBER = 'FNumber', @@ -811,7 +851,8 @@ declare namespace image { * Date time * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TIME = 'DateTime', @@ -819,7 +860,8 @@ declare namespace image { * GPS time stamp * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_TIME_STAMP = 'GPSTimeStamp', @@ -827,7 +869,8 @@ declare namespace image { * GPS date stamp * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DATE_STAMP = 'GPSDateStamp', @@ -835,7 +878,8 @@ declare namespace image { * Image description * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_DESCRIPTION = 'ImageDescription', @@ -843,7 +887,8 @@ declare namespace image { * Make * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ MAKE = 'Make', @@ -851,7 +896,8 @@ declare namespace image { * Model * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ MODEL = 'Model', @@ -859,7 +905,8 @@ declare namespace image { * Photo mode * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTO_MODE = 'PhotoMode', @@ -867,7 +914,8 @@ declare namespace image { * Sensitivity type * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ SENSITIVITY_TYPE = 'SensitivityType', @@ -875,7 +923,8 @@ declare namespace image { * Standard output sensitivity * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ STANDARD_OUTPUT_SENSITIVITY = 'StandardOutputSensitivity', @@ -883,7 +932,8 @@ declare namespace image { * Recommended exposure index * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ RECOMMENDED_EXPOSURE_INDEX = 'RecommendedExposureIndex', @@ -891,7 +941,8 @@ declare namespace image { * ISO speed * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ISO_SPEED = 'ISOSpeedRatings', @@ -899,7 +950,8 @@ declare namespace image { * Aperture value * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ APERTURE_VALUE = 'ApertureValue', @@ -907,7 +959,8 @@ declare namespace image { * Exposure bias value * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_BIAS_VALUE = 'ExposureBiasValue', @@ -915,7 +968,8 @@ declare namespace image { * Metering mode * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ METERING_MODE = 'MeteringMode', @@ -923,7 +977,8 @@ declare namespace image { * Light source * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ LIGHT_SOURCE = 'LightSource', @@ -931,7 +986,8 @@ declare namespace image { * Flash * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FLASH = 'Flash', @@ -939,7 +995,8 @@ declare namespace image { * Focal length * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCAL_LENGTH = 'FocalLength', @@ -947,7 +1004,8 @@ declare namespace image { * User comment * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ USER_COMMENT = 'UserComment', @@ -955,7 +1013,8 @@ declare namespace image { * Pixel x dimension * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ PIXEL_X_DIMENSION = 'PixelXDimension', @@ -963,7 +1022,8 @@ declare namespace image { * Pixel y dimension * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ PIXEL_Y_DIMENSION = 'PixelYDimension', @@ -971,7 +1031,8 @@ declare namespace image { * White balance * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ WHITE_BALANCE = 'WhiteBalance', @@ -979,7 +1040,8 @@ declare namespace image { * Focal length in 35mm film * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ FOCAL_LENGTH_IN_35_MM_FILM = 'FocalLengthIn35mmFilm', @@ -987,7 +1049,8 @@ declare namespace image { * Capture mode * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ CAPTURE_MODE = 'HwMnoteCaptureMode', @@ -995,7 +1058,8 @@ declare namespace image { * Physical aperture * * @syscap SystemCapability.Multimedia.Image.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ PHYSICAL_APERTURE = 'HwMnotePhysicalAperture', @@ -1004,7 +1068,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ROLL_ANGLE = 'HwMnoteRollAngle', @@ -1013,7 +1078,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PITCH_ANGLE = 'HwMnotePitchAngle', @@ -1022,7 +1088,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_FOOD_CONF = 'HwMnoteSceneFoodConf', @@ -1031,7 +1098,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_STAGE_CONF = 'HwMnoteSceneStageConf', @@ -1040,7 +1108,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_BLUE_SKY_CONF = 'HwMnoteSceneBlueSkyConf', @@ -1049,7 +1118,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_GREEN_PLANT_CONF = 'HwMnoteSceneGreenPlantConf', @@ -1058,7 +1128,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_BEACH_CONF = 'HwMnoteSceneBeachConf', @@ -1067,7 +1138,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_SNOW_CONF = 'HwMnoteSceneSnowConf', @@ -1076,7 +1148,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_SUNSET_CONF = 'HwMnoteSceneSunsetConf', @@ -1085,7 +1158,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_FLOWERS_CONF = 'HwMnoteSceneFlowersConf', @@ -1094,7 +1168,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_NIGHT_CONF = 'HwMnoteSceneNightConf', @@ -1103,7 +1178,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_TEXT_CONF = 'HwMnoteSceneTextConf', @@ -1112,7 +1188,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_COUNT = 'HwMnoteFaceCount', @@ -1121,7 +1198,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FOCUS_MODE = 'HwMnoteFocusMode', @@ -1130,7 +1208,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPRESSION = 'Compression', @@ -1139,7 +1218,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTOMETRIC_INTERPRETATION = 'PhotometricInterpretation', @@ -1148,7 +1228,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STRIP_OFFSETS = 'StripOffsets', @@ -1157,7 +1238,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SAMPLES_PER_PIXEL = 'SamplesPerPixel', @@ -1166,7 +1248,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ROWS_PER_STRIP = 'RowsPerStrip', @@ -1175,7 +1258,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STRIP_BYTE_COUNTS = 'StripByteCounts', @@ -1184,7 +1268,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ X_RESOLUTION = 'XResolution', @@ -1193,7 +1278,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ Y_RESOLUTION = 'YResolution', @@ -1202,7 +1288,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PLANAR_CONFIGURATION = 'PlanarConfiguration', @@ -1211,7 +1298,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RESOLUTION_UNIT = 'ResolutionUnit', @@ -1220,7 +1308,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TRANSFER_FUNCTION = 'TransferFunction', @@ -1229,7 +1318,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOFTWARE = 'Software', @@ -1238,7 +1328,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ARTIST = 'Artist', @@ -1247,7 +1338,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WHITE_POINT = 'WhitePoint', @@ -1256,7 +1348,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PRIMARY_CHROMATICITIES = 'PrimaryChromaticities', @@ -1265,7 +1358,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ YCBCR_COEFFICIENTS = 'YCbCrCoefficients', @@ -1274,7 +1368,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ YCBCR_SUB_SAMPLING = 'YCbCrSubSampling', @@ -1283,7 +1378,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ YCBCR_POSITIONING = 'YCbCrPositioning', @@ -1292,7 +1388,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ REFERENCE_BLACK_WHITE = 'ReferenceBlackWhite', @@ -1301,7 +1398,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COPYRIGHT = 'Copyright', @@ -1310,7 +1408,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ JPEG_INTERCHANGE_FORMAT = 'JPEGInterchangeFormat', @@ -1319,7 +1418,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ JPEG_INTERCHANGE_FORMAT_LENGTH = 'JPEGInterchangeFormatLength', @@ -1328,7 +1428,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_PROGRAM = 'ExposureProgram', @@ -1337,7 +1438,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPECTRAL_SENSITIVITY = 'SpectralSensitivity', @@ -1346,7 +1448,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OECF = 'OECF', @@ -1355,7 +1458,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXIF_VERSION = 'ExifVersion', @@ -1364,7 +1468,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DATE_TIME_DIGITIZED = 'DateTimeDigitized', @@ -1373,7 +1478,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPONENTS_CONFIGURATION = 'ComponentsConfiguration', @@ -1382,7 +1488,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHUTTER_SPEED = 'ShutterSpeedValue', @@ -1391,7 +1498,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BRIGHTNESS_VALUE = 'BrightnessValue', @@ -1400,7 +1508,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MAX_APERTURE_VALUE = 'MaxApertureValue', @@ -1409,7 +1518,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBJECT_DISTANCE = 'SubjectDistance', @@ -1418,7 +1528,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBJECT_AREA = 'SubjectArea', @@ -1427,7 +1538,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MAKER_NOTE = 'MakerNote', @@ -1436,7 +1548,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBSEC_TIME = 'SubsecTime', @@ -1445,7 +1558,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBSEC_TIME_ORIGINAL = 'SubsecTimeOriginal', @@ -1454,7 +1568,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBSEC_TIME_DIGITIZED = 'SubsecTimeDigitized', @@ -1463,7 +1578,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FLASHPIX_VERSION = 'FlashpixVersion', @@ -1472,7 +1588,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_SPACE = 'ColorSpace', @@ -1481,7 +1598,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RELATED_SOUND_FILE = 'RelatedSoundFile', @@ -1490,7 +1608,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FLASH_ENERGY = 'FlashEnergy', @@ -1499,7 +1618,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPATIAL_FREQUENCY_RESPONSE = 'SpatialFrequencyResponse', @@ -1508,7 +1628,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOCAL_PLANE_X_RESOLUTION = 'FocalPlaneXResolution', @@ -1517,7 +1638,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOCAL_PLANE_Y_RESOLUTION = 'FocalPlaneYResolution', @@ -1526,7 +1648,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FOCAL_PLANE_RESOLUTION_UNIT = 'FocalPlaneResolutionUnit', @@ -1535,7 +1658,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBJECT_LOCATION = 'SubjectLocation', @@ -1544,7 +1668,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_INDEX = 'ExposureIndex', @@ -1553,7 +1678,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SENSING_METHOD = 'SensingMethod', @@ -1562,7 +1688,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FILE_SOURCE = 'FileSource', @@ -1571,7 +1698,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CFA_PATTERN = 'CFAPattern', @@ -1580,7 +1708,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CUSTOM_RENDERED = 'CustomRendered', @@ -1589,7 +1718,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ EXPOSURE_MODE = 'ExposureMode', @@ -1598,7 +1728,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DIGITAL_ZOOM_RATIO = 'DigitalZoomRatio', @@ -1607,7 +1738,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_CAPTURE_TYPE = 'SceneCaptureType', @@ -1616,7 +1748,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GAIN_CONTROL = 'GainControl', @@ -1625,7 +1758,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CONTRAST = 'Contrast', @@ -1634,7 +1768,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SATURATION = 'Saturation', @@ -1643,7 +1778,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SHARPNESS = 'Sharpness', @@ -1652,7 +1788,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEVICE_SETTING_DESCRIPTION = 'DeviceSettingDescription', @@ -1661,7 +1798,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBJECT_DISTANCE_RANGE = 'SubjectDistanceRange', @@ -1670,7 +1808,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IMAGE_UNIQUE_ID = 'ImageUniqueID', @@ -1679,7 +1818,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_VERSION_ID = 'GPSVersionID', @@ -1688,7 +1828,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_ALTITUDE_REF = 'GPSAltitudeRef', @@ -1697,7 +1838,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_ALTITUDE = 'GPSAltitude', @@ -1706,7 +1848,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_SATELLITES = 'GPSSatellites', @@ -1715,7 +1858,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_STATUS = 'GPSStatus', @@ -1724,7 +1868,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_MEASURE_MODE = 'GPSMeasureMode', @@ -1733,7 +1878,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DOP = 'GPSDOP', @@ -1742,7 +1888,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_SPEED_REF = 'GPSSpeedRef', @@ -1751,7 +1898,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_SPEED = 'GPSSpeed', @@ -1760,7 +1908,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_TRACK_REF = 'GPSTrackRef', @@ -1769,7 +1918,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_TRACK = 'GPSTrack', @@ -1778,7 +1928,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_IMG_DIRECTION_REF = 'GPSImgDirectionRef', @@ -1787,7 +1938,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_IMG_DIRECTION = 'GPSImgDirection', @@ -1796,7 +1948,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_MAP_DATUM = 'GPSMapDatum', @@ -1805,7 +1958,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_LATITUDE_REF = 'GPSDestLatitudeRef', @@ -1814,7 +1968,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_LATITUDE = 'GPSDestLatitude', @@ -1823,7 +1978,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_LONGITUDE_REF = 'GPSDestLongitudeRef', @@ -1832,7 +1988,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_LONGITUDE = 'GPSDestLongitude', @@ -1841,7 +1998,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_BEARING_REF = 'GPSDestBearingRef', @@ -1850,7 +2008,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_BEARING = 'GPSDestBearing', @@ -1859,7 +2018,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_DISTANCE_REF = 'GPSDestDistanceRef', @@ -1868,7 +2028,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DEST_DISTANCE = 'GPSDestDistance', @@ -1877,7 +2038,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_PROCESSING_METHOD = 'GPSProcessingMethod', @@ -1886,7 +2048,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_AREA_INFORMATION = 'GPSAreaInformation', @@ -1895,7 +2058,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_DIFFERENTIAL = 'GPSDifferential', @@ -1904,7 +2068,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BODY_SERIAL_NUMBER = 'BodySerialNumber', @@ -1913,7 +2078,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CAMERA_OWNER_NAME = 'CameraOwnerName', @@ -1922,7 +2088,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPOSITE_IMAGE = 'CompositeImage', @@ -1931,7 +2098,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ COMPRESSED_BITS_PER_PIXEL = 'CompressedBitsPerPixel', @@ -1940,7 +2108,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DNG_VERSION = 'DNGVersion', @@ -1949,7 +2118,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT_CROP_SIZE = 'DefaultCropSize', @@ -1958,7 +2128,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GAMMA = 'Gamma', @@ -1967,7 +2138,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ISO_SPEED_LATITUDE_YYY = 'ISOSpeedLatitudeyyy', @@ -1976,7 +2148,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ISO_SPEED_LATITUDE_ZZZ = 'ISOSpeedLatitudezzz', @@ -1985,7 +2158,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LENS_MAKE = 'LensMake', @@ -1994,7 +2168,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LENS_MODEL = 'LensModel', @@ -2003,7 +2178,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LENS_SERIAL_NUMBER = 'LensSerialNumber', @@ -2012,7 +2188,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ LENS_SPECIFICATION = 'LensSpecification', @@ -2021,7 +2198,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NEW_SUBFILE_TYPE = 'NewSubfileType', @@ -2030,7 +2208,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OFFSET_TIME = 'OffsetTime', @@ -2039,7 +2218,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OFFSET_TIME_DIGITIZED = 'OffsetTimeDigitized', @@ -2048,7 +2228,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OFFSET_TIME_ORIGINAL = 'OffsetTimeOriginal', @@ -2057,7 +2238,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_EXPOSURE_TIMES_OF_COMPOSITE_IMAGE = 'SourceExposureTimesOfCompositeImage', @@ -2066,7 +2248,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SOURCE_IMAGE_NUMBER_OF_COMPOSITE_IMAGE = 'SourceImageNumberOfCompositeImage', @@ -2075,7 +2258,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SUBFILE_TYPE = 'SubfileType', @@ -2084,7 +2268,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GPS_H_POSITIONING_ERROR = 'GPSHPositioningError', @@ -2093,7 +2278,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PHOTOGRAPHIC_SENSITIVITY = 'PhotographicSensitivity', @@ -2102,7 +2288,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BURST_NUMBER = 'HwMnoteBurstNumber', @@ -2111,7 +2298,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_CONF = 'HwMnoteFaceConf', @@ -2120,7 +2308,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_LEYE_CENTER = 'HwMnoteFaceLeyeCenter', @@ -2129,7 +2318,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_MOUTH_CENTER = 'HwMnoteFaceMouthCenter', @@ -2138,7 +2328,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_POINTER = 'HwMnoteFacePointer', @@ -2147,7 +2338,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_RECT = 'HwMnoteFaceRect', @@ -2156,7 +2348,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_REYE_CENTER = 'HwMnoteFaceReyeCenter', @@ -2165,7 +2358,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_SMILE_SCORE = 'HwMnoteFaceSmileScore', @@ -2174,7 +2368,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FACE_VERSION = 'HwMnoteFaceVersion', @@ -2183,7 +2378,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FRONT_CAMERA = 'HwMnoteFrontCamera', @@ -2192,7 +2388,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_POINTER = 'HwMnoteScenePointer', @@ -2201,7 +2398,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCENE_VERSION = 'HwMnoteSceneVersion', @@ -2210,7 +2408,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ IS_XMAGE_SUPPORTED = 'HwMnoteIsXmageSupported', @@ -2219,7 +2418,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ XMAGE_MODE = 'HwMnoteXmageMode', @@ -2228,7 +2428,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ XMAGE_LEFT = 'HwMnoteXmageLeft', @@ -2237,7 +2438,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ XMAGE_TOP = 'HwMnoteXmageTop', @@ -2246,7 +2448,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ XMAGE_RIGHT = 'HwMnoteXmageRight', @@ -2255,7 +2458,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ XMAGE_BOTTOM = 'HwMnoteXmageBottom', @@ -2264,7 +2468,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CLOUD_ENHANCEMENT_MODE = 'HwMnoteCloudEnhancementMode', @@ -2273,7 +2478,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ WIND_SNAPSHOT_MODE = 'HwMnoteWindSnapshotMode', @@ -2283,7 +2489,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GIF_LOOP_COUNT = 'GIFLoopCount' } @@ -2293,14 +2500,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum ImageFormat { /** * YCBCR422 semi-planar format. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ YCBCR_422_SP = 1000, @@ -2308,7 +2517,8 @@ declare namespace image { * JPEG encoding format. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ JPEG = 2000 } @@ -2345,7 +2555,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AlphaType { /** @@ -2376,7 +2587,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, @@ -2408,7 +2620,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OPAQUE = 1, @@ -2440,7 +2653,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PREMUL = 2, @@ -2472,7 +2686,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ UNPREMUL = 3 } @@ -2482,14 +2697,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum DecodingDynamicRange { /** * Decoding according to the content of the image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -2497,7 +2714,8 @@ declare namespace image { * Decoding to standard dynamic range. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SDR = 1, @@ -2505,7 +2723,8 @@ declare namespace image { * Decoding to high dynamic range. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HDR = 2 } @@ -2515,14 +2734,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PackingDynamicRange { /** * Packing according to the content of the image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -2530,7 +2751,8 @@ declare namespace image { * Packing to standard dynamic range. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SDR = 1, } @@ -2548,7 +2770,8 @@ declare namespace image { * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum AntiAliasingLevel { /** @@ -2562,7 +2785,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -2577,7 +2801,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ LOW = 1, @@ -2592,7 +2817,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIUM = 2, @@ -2607,7 +2833,8 @@ declare namespace image { * * @syscap SystemCapability.Multimedia.Image.Core * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ HIGH = 3, } @@ -2644,7 +2871,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum ScaleMode { /** @@ -2675,7 +2903,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ FIT_TARGET_SIZE = 0, @@ -2707,7 +2936,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CENTER_CROP = 1 } @@ -2717,14 +2947,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ enum ComponentType { /** * Luma info. * * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ YUV_Y = 1, @@ -2732,7 +2964,8 @@ declare namespace image { * Chrominance info. * * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ YUV_U = 2, @@ -2740,7 +2973,8 @@ declare namespace image { * Chroma info. * * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ YUV_V = 3, @@ -2748,7 +2982,8 @@ declare namespace image { * Jpeg type. * * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ JPEG = 4 } @@ -2758,14 +2993,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum HdrMetadataKey { /** * Indicate the types of metadata that image needs to use. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HDR_METADATA_TYPE = 0, @@ -2773,7 +3010,8 @@ declare namespace image { * Static metadata key. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HDR_STATIC_METADATA = 1, @@ -2781,7 +3019,8 @@ declare namespace image { * Dynamic metadata key. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HDR_DYNAMIC_METADATA = 2, @@ -2789,7 +3028,8 @@ declare namespace image { * Gainmap metadata key. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HDR_GAINMAP_METADATA = 3, } @@ -2799,14 +3039,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum HdrMetadataType { /** * No metadata. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -2814,7 +3056,8 @@ declare namespace image { * Indicates that metadata will be used for the base image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BASE = 1, @@ -2822,7 +3065,8 @@ declare namespace image { * Indicates that metadata will be used for the gainmap image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ GAINMAP = 2, @@ -2830,7 +3074,8 @@ declare namespace image { * Indicates that metadata will be used for the alternate image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ALTERNATE = 3, } @@ -2840,14 +3085,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ enum AllocatorType { /** * The system determines which memory to use to create the PixelMap. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO = 0, @@ -2855,7 +3102,8 @@ declare namespace image { * Use DMA buffer to create the PixelMap. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DMA = 1, @@ -2863,7 +3111,8 @@ declare namespace image { * Use share memory to create the PixelMap. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ SHARE_MEMORY = 2, } @@ -2900,7 +3149,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface Region { /** @@ -2935,7 +3185,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size: Size; @@ -2966,14 +3217,15 @@ declare namespace image { /** * x-coordinate at the upper left corner of the image. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - x: number; + x: int; /** * y-coordinate at the upper left corner of the image. @@ -3002,14 +3254,15 @@ declare namespace image { /** * y-coordinate at the upper left corner of the image. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - y: number; + y: int; } /** @@ -3044,7 +3297,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PositionArea { /** @@ -3079,7 +3333,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pixels: ArrayBuffer; @@ -3110,14 +3365,15 @@ declare namespace image { /** * Offset for data reading. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - offset: number; + offset: int; /** * Number of bytes to read. @@ -3146,14 +3402,15 @@ declare namespace image { /** * Number of bytes to read. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - stride: number; + stride: int; /** * Region to read. @@ -3187,7 +3444,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ region: Region; } @@ -3224,7 +3482,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImageInfo { /** @@ -3259,7 +3518,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size: Size; @@ -3290,14 +3550,15 @@ declare namespace image { /** * Indicates image default density. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - density: number; + density: int; /** * The number of byte per row. @@ -3310,13 +3571,14 @@ declare namespace image { /** * The number of byte per row. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - stride: number; + stride: int; /** * Indicates image format. @@ -3326,7 +3588,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pixelFormat: PixelMapFormat; @@ -3338,7 +3601,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alphaType: AlphaType; @@ -3348,7 +3612,8 @@ declare namespace image { * @type { string } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ mimeType: string; @@ -3357,7 +3622,8 @@ declare namespace image { * * @type { boolean } * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isHdr: boolean; } @@ -3367,14 +3633,16 @@ declare namespace image { * * @enum { number } * @syscap SystemCapability.Multimedia.Image.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enum CropAndScaleStrategy { /** * Scales and then crops the image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SCALE_FIRST = 1, @@ -3382,7 +3650,8 @@ declare namespace image { * Crops and then scales the image. * * @syscap SystemCapability.Multimedia.Image.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CROP_FIRST = 2 } @@ -3409,7 +3678,8 @@ declare namespace image { * @syscap SystemCapability.Multimedia.Image.ImagePacker * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PackingOption { /** @@ -3434,7 +3704,8 @@ declare namespace image { * @syscap SystemCapability.Multimedia.Image.ImagePacker * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ format: string; @@ -3456,13 +3727,14 @@ declare namespace image { /** * Quality of the target image. The value is an integer ranging from 0 to 100. A larger value indicates better. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.ImagePacker * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - quality: number; + quality: int; /** * BufferSize of the target image. @@ -3485,20 +3757,22 @@ declare namespace image { * BufferSize of the target image. * If this bufferSize is less than or equal to 0, it will be converted to 10MB. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Image.ImagePacker * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - bufferSize?: number; + bufferSize?: int; /** * The desired dynamic range of the target image. * * @type { ?PackingDynamicRange } * @syscap SystemCapability.Multimedia.Image.ImagePacker - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ desiredDynamicRange?: PackingDynamicRange; @@ -3507,7 +3781,8 @@ declare namespace image { * * @type { ?boolean } * @syscap SystemCapability.Multimedia.Image.ImagePacker - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ needsPackProperties?: boolean; } @@ -3628,18 +3903,20 @@ declare namespace image { * @typedef ImagePropertyOptions * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface ImagePropertyOptions { /** * Index of an image. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - index?: number; + index?: int; /** * Default property value. @@ -3647,7 +3924,8 @@ declare namespace image { * @type { ?string } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ defaultValue?: string; } @@ -3684,7 +3962,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DecodingOptions { /** @@ -3714,14 +3993,15 @@ declare namespace image { /** * Number of image frames. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - index?: number; + index?: int; /** * Sampling ratio of the image pixel map. @@ -3750,14 +4030,15 @@ declare namespace image { /** * Sampling ratio of the image pixel map. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - sampleSize?: number; + sampleSize?: int; /** * Rotation angle of the image pixel map. The value ranges from 0 to 360. @@ -3786,14 +4067,15 @@ declare namespace image { /** * Rotation angle of the image pixel map. The value ranges from 0 to 360. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - rotate?: number; + rotate?: int; /** * Whether the image pixel map is editable. @@ -3827,7 +4109,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ editable?: boolean; @@ -3867,7 +4150,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ desiredSize?: Size; @@ -3903,7 +4187,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ desiredRegion?: Region; @@ -3939,7 +4224,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ desiredPixelFormat?: PixelMapFormat; @@ -3970,14 +4256,15 @@ declare namespace image { /** * The density for image pixel map. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - fitDensity?: number; + fitDensity?: int; /** * Color space of the image pixel map. @@ -3985,7 +4272,8 @@ declare namespace image { * @type { ?colorSpaceManager.ColorSpaceManager } * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ desiredColorSpace?: colorSpaceManager.ColorSpaceManager; @@ -3994,7 +4282,8 @@ declare namespace image { * * @type { ?DecodingDynamicRange } * @syscap SystemCapability.Multimedia.Image.ImageSource - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ desiredDynamicRange?: DecodingDynamicRange; @@ -4004,7 +4293,8 @@ declare namespace image { * @type { ?ResolutionQuality } * @syscap SystemCapability.Multimedia.Image.ImageSource * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ resolutionQuality?: ResolutionQuality; @@ -4013,7 +4303,8 @@ declare namespace image { * * @type { ?CropAndScaleStrategy } * @syscap SystemCapability.Multimedia.Image.ImageSource - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ cropAndScaleStrategy?: CropAndScaleStrategy; } @@ -4023,7 +4314,8 @@ declare namespace image { * * @typedef Component * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface Component { /** @@ -4032,29 +4324,32 @@ declare namespace image { * @type { ComponentType } * @readonly * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly componentType: ComponentType; /** * Row stride. * - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly rowStride: number; + readonly rowStride: int; /** * Pixel stride. * - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly pixelStride: number; + readonly pixelStride: int; /** * Component buffer. @@ -4062,7 +4357,8 @@ declare namespace image { * @type { ArrayBuffer } * @readonly * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly byteBuffer: ArrayBuffer; } @@ -4099,7 +4395,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface InitializationOptions { /** @@ -4134,7 +4431,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ size: Size; @@ -4143,7 +4441,8 @@ declare namespace image { * * @type { ?PixelMapFormat } * @syscap SystemCapability.Multimedia.Image.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ srcPixelFormat?: PixelMapFormat; @@ -4179,7 +4478,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pixelFormat?: PixelMapFormat; @@ -4215,7 +4515,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ editable?: boolean; @@ -4251,7 +4552,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alphaType?: AlphaType; @@ -4287,7 +4589,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ scaleMode?: ScaleMode; } @@ -4324,7 +4627,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface SourceOptions { /** @@ -4354,14 +4658,15 @@ declare namespace image { /** * The density for ImageSource. * - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - sourceDensity: number; + sourceDensity: int; /** * PixelMap expected format. @@ -4395,7 +4700,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sourcePixelFormat?: PixelMapFormat; @@ -4431,7 +4737,8 @@ declare namespace image { * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sourceSize?: Size; } @@ -4669,7 +4976,8 @@ declare namespace image { * @param { AsyncCallback } callback Callback used to return the PixelMap object. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function createPixelMap(colors: ArrayBuffer, options: InitializationOptions, callback: AsyncCallback): void; @@ -4690,7 +4998,8 @@ declare namespace image { * @returns { Promise } A Promise instance used to return the PixelMap object. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function createPixelMap(colors: ArrayBuffer, options: InitializationOptions): Promise; @@ -4704,7 +5013,8 @@ declare namespace image { * 2.Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createPixelMapSync(colors: ArrayBuffer, options: InitializationOptions): PixelMap; @@ -4717,7 +5027,8 @@ declare namespace image { * 2.Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createPixelMapSync(options: InitializationOptions): PixelMap; @@ -4822,7 +5133,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -4837,7 +5149,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -5411,7 +5737,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -5795,7 +6125,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -5808,7 +6139,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the operation result. If the operation fails, an error message is returned. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - opacity(rate: number, callback: AsyncCallback): void; + opacity(rate: float, callback: AsyncCallback): void; /** * Set the transparent rate of pixel map. This method uses a promise to return the result. @@ -5990,29 +6325,31 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. If the operation fails, an error message is returned. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - opacity(rate: number): Promise; + opacity(rate: float): Promise; /** * Set the transparent rate of pixel map. * - * @param { number } rate The value of transparent rate. + * @param { float } rate The value of transparent rate. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 501 - Resource Unavailable. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - opacitySync(rate: number): void; + opacitySync(rate: float): void; /** * Obtains new pixel map with alpha information. This method uses a promise to return the information. * @@ -6045,7 +6382,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -6081,7 +6419,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -6094,7 +6433,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the operation result. If the operation fails, an error message is returned. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - scale(x: number, y: number, callback: AsyncCallback): void; + scale(x: float, y: float, callback: AsyncCallback): void; /** * Image zoom in width and height. This method uses a promise to return the result. @@ -6174,37 +6515,39 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. If the operation fails, an error message is returned. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - scale(x: number, y: number): Promise; + scale(x: float, y: float): Promise; /** * Image zoom in width and height. * - * @param { number } x The zoom value of width. - * @param { number } y The zoom value of height. + * @param { float } x The zoom value of width. + * @param { float } y The zoom value of height. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 501 - Resource Unavailable. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - scaleSync(x: number, y: number): void; + scaleSync(x: float, y: float): void; /** * Image zoom in width and height width with anti-aliasing. This method uses a promise to return the result. * - * @param { number } x The zoom value of width. - * @param { number } y The zoom value of height. + * @param { float } x The zoom value of width. + * @param { float } y The zoom value of height. * @param { AntiAliasingLevel } level The anti-aliasing algorithm to be used. * @returns { Promise } A Promise instance used to return the operation result. If the operation fails, an error message is returned. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. @@ -6214,15 +6557,16 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; + scale(x: float, y: float, level: AntiAliasingLevel): Promise; /** * Image zoom in width and height with anti-aliasing. * - * @param { number } x The zoom value of width. - * @param { number } y The zoom value of height. + * @param { float } x The zoom value of width. + * @param { float } y The zoom value of height. * @param { AntiAliasingLevel } level The anti-aliasing algorithm to be used. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. * 2.Incorrect parameter types. 3.Parameter verification failed. @@ -6230,9 +6574,10 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the operation result. If the operation fails, an error message is returned. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - rotate(angle: number, callback: AsyncCallback): void; + rotate(angle: float, callback: AsyncCallback): void; /** * Image rotation. This method uses a promise to return the result. @@ -6437,29 +6783,31 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. If the operation fails, an error message is returned. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - rotate(angle: number): Promise; + rotate(angle: float): Promise; /** * Image rotation. * - * @param { number } angle The rotation angle. + * @param { float } angle The rotation angle. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 501 - Resource Unavailable. * @syscap SystemCapability.Multimedia.Image.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - rotateSync(angle: number): void; + rotateSync(angle: float): void; /** * Image flipping. This method uses a callback to return the operation result. @@ -6501,7 +6849,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -6545,7 +6894,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -6560,7 +6910,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -6640,7 +6992,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -6654,7 +7007,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -6879,7 +7235,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -6919,7 +7276,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -7147,7 +7512,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -7156,7 +7522,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise @@ -7185,7 +7553,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise @@ -7213,7 +7582,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): Promise> @@ -7326,7 +7707,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): Promise @@ -7336,7 +7718,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } Array of Records instance used to return the property values. * @syscap SystemCapability.Multimedia.Image.Core - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ getAllProperties(): Promise> @@ -7347,7 +7730,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } @@ -7364,7 +7748,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the image information. * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - getImageInfo(index: number, callback: AsyncCallback): void; + getImageInfo(index: int, callback: AsyncCallback): void; /** * Obtains information about this image and uses a callback to return the result. @@ -7576,7 +7972,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -7610,26 +8007,28 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the image information. * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform * @form * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - getImageInfo(index?: number): Promise; + getImageInfo(index?: int): Promise; /** * Get image information from image source synchronously. * - * @param { number } index - Index of sequence images. If this parameter is not specified, default value is 0. + * @param { int } index - Index of sequence images. If this parameter is not specified, default value is 0. * @returns { ImageInfo } The image information. * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - getImageInfoSync(index?: number): ImageInfo; + getImageInfoSync(index?: int): ImageInfo; /** * Creates a PixelMap object based on image decoding parameters. This method uses a promise to @@ -7671,7 +8070,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -7707,7 +8107,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -7751,7 +8152,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; @@ -7775,7 +8177,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -7786,7 +8189,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise>; @@ -7918,7 +8324,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise>): void; @@ -7974,7 +8381,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise>): void; @@ -8000,7 +8408,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } A Promise instance used to return the array. + * @returns { Promise> } A Promise instance used to return the array. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980111 - The image source data is incomplete. @@ -8014,9 +8422,10 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise>; + getDelayTimeList(): Promise>; /** * Obtains the array of delay time in an image. This method uses a callback to return the array. @@ -8040,7 +8449,7 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise> } callback Callback used to return the array. + * @param { AsyncCallback> } callback Callback used to return the array. * @throws { BusinessError } 62980096 - The operation failed. * @throws { BusinessError } 62980110 - The image source data is incorrect. * @throws { BusinessError } 62980111 - The image source data is incomplete. @@ -8054,9 +8463,10 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise>): void; + getDelayTimeList(callback: AsyncCallback>): void; /** * Obtains the array of disposal type in a gif image. This method uses a promise to return the array. @@ -8194,7 +8604,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -8291,7 +8702,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): Promise>; @@ -8325,7 +8737,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -8397,7 +8810,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): Promise; @@ -8494,7 +8908,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -8511,7 +8926,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImageSource * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; @@ -8544,7 +8960,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; } @@ -8571,7 +8988,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the operation result. * @throws { BusinessError } 62980096 - The Operation failed. @@ -8803,15 +9221,16 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; + packToFile(source: ImageSource, fd: int, options: PackingOption, callback: AsyncCallback): void; /** * Compresses or packs an image into a file and uses a promise to return the result. * * @param { ImageSource } source Image to be processed. - * @param { number } fd ID of a file descriptor. + * @param { int } fd ID of a file descriptor. * @param { PackingOption } options Options for image packing. * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 62980096 - The Operation failed. @@ -8825,15 +9244,16 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; + packToFile(source: ImageSource, fd: int, options: PackingOption): Promise; /** * Compresses or packs an image into a file and uses a callback to return the result. * * @param { PixelMap } source PixelMap to be processed. - * @param { number } fd ID of a file descriptor. + * @param { int } fd ID of a file descriptor. * @param { PackingOption } options Options for image packing. * @param { AsyncCallback } callback Callback used to return the operation result. * @throws { BusinessError } 62980096 - The Operation failed. @@ -8847,15 +9267,16 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise): void; + packToFile(source: PixelMap, fd: int, options: PackingOption, callback: AsyncCallback): void; /** * Compresses or packs an image into a file and uses a promise to return the result. * * @param { PixelMap } source PixelMap to be processed. - * @param { number } fd ID of a file descriptor. + * @param { int } fd ID of a file descriptor. * @param { PackingOption } options Options for image packing. * @returns { Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 62980096 - The Operation failed. @@ -8869,9 +9290,10 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; + packToFile(source: PixelMap, fd: int, options: PackingOption): Promise; /** * Compresses a Pixelmap sequence into gif. @@ -8902,7 +9324,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImagePacker * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -8919,7 +9342,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImagePacker * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; @@ -8933,7 +9357,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; @@ -8941,16 +9366,17 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. * @throws { BusinessError } 401 - Parameter error.Possible causes: 1.Mandatory parameters are left unspecified. * 2.Incorrect parameter types. 3.Parameter verification failed. * @throws { BusinessError } 7800301 - Encode failed. * @syscap SystemCapability.Multimedia.Image.ImagePacker - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ - packToFile(picture: Picture, fd: number, options: PackingOption): Promise + packToFile(picture: Picture, fd: int, options: PackingOption): Promise /** * Supported image formats. @@ -8967,7 +9393,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise; } @@ -8977,7 +9404,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the component buffer. * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getComponent(componentType: ComponentType, callback: AsyncCallback): void; @@ -9035,7 +9468,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the component buffer. * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getComponent(componentType: ComponentType): Promise; @@ -9044,7 +9478,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback to return the operation result. * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -9053,7 +9488,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. * @syscap SystemCapability.Multimedia.Image.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; } @@ -9063,7 +9499,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the surface id. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getReceivingSurfaceId(callback: AsyncCallback): void; @@ -9112,7 +9553,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the surface id. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getReceivingSurfaceId(): Promise; @@ -9121,7 +9563,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return the latest image. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readLatestImage(callback: AsyncCallback): void; @@ -9130,7 +9573,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the latest image. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readLatestImage(): Promise; @@ -9158,7 +9602,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback used to return image. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'imageArrival', callback: AsyncCallback): void; @@ -9168,7 +9613,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback to be removed. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'imageArrival', callback?: AsyncCallback): void; @@ -9177,7 +9623,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -9186,7 +9633,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImageReceiver - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; } @@ -9196,18 +9644,20 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } callback Callback to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImageCreator - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -9291,7 +9743,8 @@ function createUnpremultipliedPixelMap(src: PixelMap, dst: PixelMap): Promise } A Promise instance used to return the operation result. * @syscap SystemCapability.Multimedia.Image.ImageCreator - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; } diff --git a/api/@ohos.multimedia.media.d.ts b/api/@ohos.multimedia.media.d.ts old mode 100755 new mode 100644 index 214da6eb636ee75d85f969eb0210e14e2f9f239c..ba9645edc9171895a40e2693093f433d7f0a44a4 --- a/api/@ohos.multimedia.media.d.ts +++ b/api/@ohos.multimedia.media.d.ts @@ -18,12 +18,12 @@ * @kit MediaKit */ -import { ErrorCallback, AsyncCallback, Callback } from './@ohos.base'; +import { ErrorCallback, AsyncCallback, Callback, BusinessError } from './@ohos.base'; import audio from "./@ohos.multimedia.audio"; -import photoAccessHelper from "./@ohos.file.photoAccessHelper"; -import type image from './@ohos.multimedia.image'; -import type { SoundPool as _SoundPool } from './multimedia/soundPool'; -import type { PlayParameters as _PlayParameters } from './multimedia/soundPool'; +import photoAccessHelper from './@ohos.file.photoAccessHelper'; +import image from './@ohos.multimedia.image'; +import { SoundPool as _SoundPool } from './multimedia/soundPool'; +import { PlayParameters as _PlayParameters } from './multimedia/soundPool'; import type drm from './@ohos.multimedia.drm'; /** @@ -40,7 +40,8 @@ import type drm from './@ohos.multimedia.drm'; * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace media { /** @@ -65,7 +66,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVPlayer(callback: AsyncCallback): void; @@ -91,7 +93,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVPlayer(): Promise; @@ -108,7 +111,8 @@ declare namespace media { * @throws { BusinessError } 5400101 - No memory. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVRecorder(callback: AsyncCallback): void; @@ -126,7 +130,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVRecorder(): Promise; @@ -223,7 +228,8 @@ declare namespace media { * @throws { BusinessError } 5400101 - No memory. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createVideoRecorder(callback: AsyncCallback): void; @@ -244,22 +250,24 @@ declare namespace media { * @throws { BusinessError } 5400101 - No memory. Return by promise. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createVideoRecorder(): Promise; /** * Creates a soundPool instance. * - * @param {number} maxStreams The maximum number of simultaneous streams for this soundPool instance + * @param {int} maxStreams The maximum number of simultaneous streams for this soundPool instance * @param {audio.AudioRendererInfo} audioRenderInfo Audio renderer information * @param {AsyncCallback} callback Callback used to return soundPool instance if the operation is successful; returns null otherwise. * @throws { BusinessError } 5400101 - No memory. Return by callback. * @syscap SystemCapability.Multimedia.Media.SoundPool - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function createSoundPool( - maxStreams: number, + maxStreams: int, audioRenderInfo: audio.AudioRendererInfo, callback: AsyncCallback ): void; @@ -267,14 +275,15 @@ declare namespace media { /** * Creates a soundPool instance. * - * @param {number} maxStreams The maximum number of simultaneous streams for this soundPool instance + * @param {int} maxStreams The maximum number of simultaneous streams for this soundPool instance * @param {audio.AudioRendererInfo} audioRenderInfo Audio renderer information * @returns {Promise} A Promise instance used to return SoundPool instance if the operation is successful; returns null otherwise. * @throws { BusinessError } 5400101 - No memory. Return by promise. * @syscap SystemCapability.Multimedia.Media.SoundPool - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function createSoundPool(maxStreams: number, audioRenderInfo: audio.AudioRendererInfo): Promise; + function createSoundPool(maxStreams: int, audioRenderInfo: audio.AudioRendererInfo): Promise; /** * Creates an AVScreenCaptureRecorder instance. @@ -282,7 +291,8 @@ declare namespace media { * returns null otherwise. * @throws { BusinessError } 5400101 - No memory. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVScreenCaptureRecorder(): Promise; @@ -307,19 +317,22 @@ declare namespace media { * @returns {Promise} A Promise instance used to return AVTranscoder instance if the operation is successful; returns null otherwise. * @throws { BusinessError } 5400101 - No memory. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVTranscoder(): Promise; /** * Get the ScreenCaptureMonitor instance * - * @returns { Promise } A Promise instance used to return ScreenCaptureMonitor instance if the operation is successful; returns null otherwise. + * @returns { Promise } A Promise instance used to return ScreenCaptureMonitor instance if the operation is successful; + * returns null otherwise. * @throws { BusinessError } 202 - Not System App. * @throws { BusinessError } 5400101 - No memory. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function getScreenCaptureMonitor(): Promise; @@ -329,7 +342,8 @@ declare namespace media { * * @typedef { _SoundPool } * @syscap SystemCapability.Multimedia.Media.SoundPool - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type SoundPool = _SoundPool; @@ -338,7 +352,8 @@ declare namespace media { * * @typedef { _PlayParameters } * @syscap SystemCapability.Multimedia.Media.SoundPool - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ type PlayParameters = _PlayParameters; @@ -364,7 +379,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum StateChangeReason { /** @@ -383,7 +399,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ USER = 1, @@ -403,7 +420,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BACKGROUND = 2, } @@ -423,7 +441,8 @@ declare namespace media { * @throws { BusinessError } 5400101 - No memory. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVMetadataExtractor(): Promise; @@ -442,7 +461,8 @@ declare namespace media { * @throws { BusinessError } 5400101 - No memory. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVMetadataExtractor(callback: AsyncCallback): void; @@ -452,7 +472,8 @@ declare namespace media { * if the operation is successful; returns null otherwise. * @throws { BusinessError } 5400101 - No memory. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVImageGenerator(): Promise; @@ -462,7 +483,8 @@ declare namespace media { * if the operation is successful; returns null otherwise. * @throws { BusinessError } 5400101 - No memory. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createAVImageGenerator(callback: AsyncCallback): void; @@ -479,7 +501,8 @@ declare namespace media { * @typedef AVMetadataExtractor * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVMetadataExtractor { /** @@ -493,7 +516,8 @@ declare namespace media { * @type { ?AVFileDescriptor } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fdSrc ?: AVFileDescriptor; @@ -508,7 +532,8 @@ declare namespace media { * @type { ?AVDataSrcDescriptor } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dataSrc ?: AVDataSrcDescriptor; @@ -527,7 +552,8 @@ declare namespace media { * @throws { BusinessError } 5400106 - Unsupported format. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fetchMetadata(callback: AsyncCallback): void; @@ -546,7 +572,8 @@ declare namespace media { * @throws { BusinessError } 5400106 - Unsupported format. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fetchMetadata(): Promise; @@ -567,7 +594,8 @@ declare namespace media { * @throws { BusinessError } 5400106 - Unsupported format. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fetchAlbumCover(callback: AsyncCallback): void; @@ -586,7 +614,8 @@ declare namespace media { * @throws { BusinessError } 5400106 - Unsupported format. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fetchAlbumCover(): Promise; @@ -629,7 +658,8 @@ declare namespace media { * @throws { BusinessError } 5400102 - Operation not allowed. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -646,7 +676,8 @@ declare namespace media { * @throws { BusinessError } 5400102 - Operation not allowed. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; } @@ -662,7 +693,8 @@ declare namespace media { * @typedef AVMetadata * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVMetadata { /** @@ -678,7 +710,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ album?: string; @@ -695,7 +728,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ albumArtist?: string; @@ -712,7 +746,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ artist?: string; @@ -729,7 +764,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ author?: string; @@ -746,7 +782,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dateTime?: string; @@ -763,7 +800,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dateTimeFormat?: string; @@ -780,7 +818,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ composer?: string; @@ -795,7 +834,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: string; @@ -812,7 +852,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ genre?: string; @@ -827,7 +868,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ hasAudio?: string; @@ -842,7 +884,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ hasVideo?: string; @@ -859,7 +902,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ mimeType?: string; @@ -876,7 +920,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ trackCount?: string; @@ -891,7 +936,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ sampleRate?: string; @@ -906,7 +952,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ title?: string; @@ -921,7 +968,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoHeight?: string; @@ -936,7 +984,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoWidth?: string; @@ -953,7 +1002,8 @@ declare namespace media { * @type { ?string } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoOrientation?: string; @@ -962,7 +1012,8 @@ declare namespace media { * @type { ?HdrType } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ hdrType?: HdrType; @@ -970,7 +1021,8 @@ declare namespace media { * The geographical location info of the video. * @type { ?Location } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ location?: Location; @@ -978,7 +1030,8 @@ declare namespace media { * Custom parameter key-value map read from moov.meta.list. * @type { ?Record } * @syscap SystemCapability.Multimedia.Media.AVMetadataExtractor - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ customInfo?: Record; } @@ -988,14 +1041,16 @@ declare namespace media { * @enum { number } * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum HdrType { /** * This option is used to mark none HDR type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AV_HDR_TYPE_NONE = 0, @@ -1003,7 +1058,8 @@ declare namespace media { * This option is used to mark HDR Vivid type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AV_HDR_TYPE_VIVID = 1, } @@ -1013,20 +1069,22 @@ declare namespace media { * you must use createAVImageGenerator() to create an AVImageGenerator instance. * @typedef AVImageGenerator * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVImageGenerator { /** * Media file descriptor. * @type { ?AVFileDescriptor } * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fdSrc ?: AVFileDescriptor; /** * It will fetch a picture at @timeUs from the given video resource. - * @param { number } timeUs - The time expected to fetch picture from the video resource. + * @param { long } timeUs - The time expected to fetch picture from the video resource. * The unit is microsecond(us). * @param { AVImageQueryOptions } options - The time options about the relationship * between the given timeUs and a key frame, see @AVImageQueryOptions . @@ -1036,15 +1094,16 @@ declare namespace media { * @throws { BusinessError } 5400102 - Operation not allowed. Returned by callback. * @throws { BusinessError } 5400106 - Unsupported format. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - fetchFrameByTime(timeUs: number, options: AVImageQueryOptions, param: PixelMapParams, + fetchFrameByTime(timeUs: long, options: AVImageQueryOptions, param: PixelMapParams, callback: AsyncCallback): void; /** * It will decode the given video resource. Then fetch a picture * at @timeUs according the given @options and @param . - * @param { number } timeUs - The time expected to fetch picture from the video resource. + * @param { long } timeUs - The time expected to fetch picture from the video resource. * The unit is microsecond(us). * @param { AVImageQueryOptions } options - The time options about the relationship * between the given timeUs and a key frame, see @AVImageQueryOptions . @@ -1054,16 +1113,18 @@ declare namespace media { * @throws { BusinessError } 5400102 - Operation not allowed. Returned by promise. * @throws { BusinessError } 5400106 - Unsupported format. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - fetchFrameByTime(timeUs: number, options: AVImageQueryOptions, param: PixelMapParams): Promise; + fetchFrameByTime(timeUs: long, options: AVImageQueryOptions, param: PixelMapParams): Promise; /** * Release resources used for AVImageGenerator. * @param { AsyncCallback } callback - A callback instance used to return when release completed. * @throws { BusinessError } 5400102 - Operation not allowed. Returned by callback. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -1072,7 +1133,8 @@ declare namespace media { * @returns { Promise } A Promise instance used to return when release completed. * @throws { BusinessError } 5400102 - Operation not allowed. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; } @@ -1081,14 +1143,16 @@ declare namespace media { * Enumerates options about the relationship between the given timeUs and a key frame. * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AVImageQueryOptions { /** * This option is used to fetch a key frame from the given media * resource that is located right after or at the given time. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AV_IMAGE_QUERY_NEXT_SYNC, @@ -1096,7 +1160,8 @@ declare namespace media { * This option is used to fetch a key frame from the given media * resource that is located right before or at the given time. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AV_IMAGE_QUERY_PREVIOUS_SYNC, @@ -1104,7 +1169,8 @@ declare namespace media { * This option is used to fetch a key frame from the given media * resource that is located closest to or at the given time. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AV_IMAGE_QUERY_CLOSEST_SYNC, @@ -1112,7 +1178,8 @@ declare namespace media { * This option is used to fetch a frame (maybe not keyframe) from * the given media resource that is located closest to or at the given time. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AV_IMAGE_QUERY_CLOSEST, } @@ -1121,33 +1188,37 @@ declare namespace media { * Expected pixel map format for the fetched image from video resource. * @typedef PixelMapParams * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PixelMapParams { /** * Expected pixelmap's width, -1 means to keep consistent with the * original dimensions of the given video resource. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - width?: number; + width?: int; /** * Expected pixelmap's width, -1 means to keep consistent with the * original dimensions of the given video resource. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVImageGenerator - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - height?: number; + height?: int; /** * Expected pixelmap's color format, see {@link PixelFormat}. * @type { ?PixelFormat } * @syscap SystemCapability.Multimedia.Media.AVImageGenerator * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ colorFormat?: PixelFormat; } @@ -1157,14 +1228,16 @@ declare namespace media { * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVImageGenerator * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PixelFormat { /** * RGB_565 options. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RGB_565 = 2, @@ -1172,7 +1245,8 @@ declare namespace media { * RGBA_8888 options. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RGBA_8888 = 3, @@ -1180,7 +1254,8 @@ declare namespace media { * RGB_888 options. * @syscap SystemCapability.Multimedia.Media.AVImageGenerator * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RGB_888 = 5, } @@ -1560,20 +1635,22 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AVPlayerState = 'idle' | 'initialized' | 'prepared' | 'playing' | 'paused' | 'completed' | 'stopped' | 'released' | 'error'; /** * Define the TrackChange Event callback. * @typedef { function } OnTrackChangeHandler - * @param { number } index - index number for change Track. + * @param { int } index - index number for change Track. * @param { boolean } isSelected - Target index number for moving elements. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - type OnTrackChangeHandler = (index: number, isSelected: boolean) => void; + type OnTrackChangeHandler = (index: int, isSelected: boolean) => void; /** * Defines the OnStateChange callback. @@ -1584,7 +1661,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type OnAVPlayerStateChangeHandle = (state: AVPlayerState, reason: StateChangeReason) => void; @@ -1593,26 +1671,28 @@ declare namespace media { * * @typedef { function } OnBufferingUpdateHandler * @param { BufferingInfoType } infoType - define the Buffering info Type. - * @param { number } value - define the value of buffering info type if exist. + * @param { int } value - define the value of buffering info type if exist. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - type OnBufferingUpdateHandler = (infoType: BufferingInfoType, value: number) => void; + type OnBufferingUpdateHandler = (infoType: BufferingInfoType, value: int) => void; /** * Defines the OnVideoSizeChangeHandler callback. * * @typedef { function } OnVideoSizeChangeHandler - * @param { number } width - Value of video Width. - * @param { number } height - Value of video Height. + * @param { int } width - Value of video Width. + * @param { int } height - Value of video Height. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - type OnVideoSizeChangeHandler = (width: number, height: number) => void; + type OnVideoSizeChangeHandler = (width: int, height: int) => void; /** * Defines the OnSuperResolutionChanged callback. @@ -1621,7 +1701,8 @@ declare namespace media { * @param { boolean } enabled - Super-resolution enabled or not. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ type OnSuperResolutionChanged = (enabled: boolean) => void; @@ -1631,24 +1712,27 @@ declare namespace media { * @typedef SeiMessage * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface SeiMessage { /** * Payload type of SEI message. - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - payloadType: number; + payloadType: int; /** * Payload data of SEI message. * @type { ArrayBuffer } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ payload: ArrayBuffer; } @@ -1658,12 +1742,13 @@ declare namespace media { * * @typedef { function } OnSeiMessageHandle * @param { Array } messages - SEI messages. - * @param { ?number } playbackPosition - playback position. + * @param { ?int } playbackPosition - playback position. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - type OnSeiMessageHandle = (messages: Array, playbackPosition?: number) => void; + type OnSeiMessageHandle = (messages: Array, playbackPosition?: int) => void; /** * Manages and plays media. Before calling an AVPlayer method, you must use createAVPlayer() @@ -1690,7 +1775,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVPlayer { /** @@ -1718,7 +1804,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(callback: AsyncCallback): void; @@ -1747,7 +1834,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(): Promise; @@ -1773,7 +1861,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ play(callback: AsyncCallback): void; @@ -1799,7 +1888,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ play(): Promise; @@ -1825,7 +1915,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(callback: AsyncCallback): void; @@ -1851,7 +1942,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(): Promise; @@ -1877,7 +1969,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(callback: AsyncCallback): void; @@ -1903,7 +1996,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(): Promise; @@ -1929,7 +2023,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reset(callback: AsyncCallback): void; @@ -1955,7 +2050,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reset(): Promise; @@ -1981,7 +2077,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -2007,20 +2104,21 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; /** * Jumps to the specified playback position. - * @param { number } timeMs - Playback position to jump, should be in [0, duration]. + * @param { int } timeMs - Playback position to jump, should be in [0, duration]. * @param { SeekMode } mode - See @SeekMode . * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Jumps to the specified playback position. - * @param { number } timeMs - Playback position to jump, should be in [0, duration]. + * @param { int } timeMs - Playback position to jump, should be in [0, duration]. * @param { SeekMode } mode - See @SeekMode . * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice @@ -2028,30 +2126,32 @@ declare namespace media { */ /** * Jumps to the specified playback position. - * @param { number } timeMs - Playback position to jump, should be in [0, duration]. + * @param { int } timeMs - Playback position to jump, should be in [0, duration]. * @param { SeekMode } mode - See @SeekMode . * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - seek(timeMs: number, mode?: SeekMode): void; + seek(timeMs: int, mode?: SeekMode): void; /** * Sets the volume. - * @param { number } volume - Relative volume. The value ranges from 0.00 to 1.00. The value 1 indicates the maximum volume (100%). + * @param { double } volume - Relative volume. The value ranges from 0.00 to 1.00. The value 1 indicates the maximum volume (100%). * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Sets the volume. - * @param { number } volume - Relative volume. The value ranges from 0.00 to 1.00. The value 1 indicates the maximum volume (100%). + * @param { double } volume - Relative volume. The value ranges from 0.00 to 1.00. The value 1 indicates the maximum volume (100%). * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - setVolume(volume: number): void; + setVolume(volume: double): void; /** * Get all track infos in MediaDescription, should be called after data loaded callback. @@ -2075,7 +2175,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getTrackDescription(callback: AsyncCallback>): void; @@ -2101,7 +2202,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getTrackDescription(): Promise>; @@ -2186,11 +2288,11 @@ declare namespace media { /** * Get statistic infos of current player. - * @returns { Promise } Statistic infos of current player. + * @returns { Promise> } Statistic infos of current player. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 12 */ - getPlaybackInfo(): Promise; + getPlaybackInfo(): Promise>; /** * Set playback strategy to AVPlayer. @@ -2233,20 +2335,10 @@ declare namespace media { * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since 12 */ setPlaybackRange(startTimeMs: number, endTimeMs: number, mode?: SeekMode) : Promise; - /** - * Get current playback position. - * @returns { number } return the time of current playback position - millisecond(ms) - * @throws { BusinessError } 5400102 - Operation not allowed. - * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @atomicservice - * @since 18 - */ - getPlaybackPosition() : number; - /** * Check whether the media stream currently being played by the player supports seek continuous. * Should be called after {@link #prepare}. @@ -2254,10 +2346,21 @@ declare namespace media { * false: seek continuous is not supported or the support status is uncertain. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ isSeekContinuousSupported() : boolean; + /** + * Get current playback position. + * @returns { number } return the time of current playback position - millisecond(ms) + * @throws { BusinessError } 5400102 - Operation not allowed. + * @syscap SystemCapability.Multimedia.Media.AVPlayer + * @atomicservice + * @since 12 + */ + getPlaybackPosition() : number; + /** * Enable or disable super-resolution dynamically. * Must enable super-resolution feature in {@link PlaybackStrategy} before calling {@link #prepare}. @@ -2270,7 +2373,7 @@ declare namespace media { * Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since 12 */ setSuperResolution(enabled: boolean) : Promise; @@ -2288,7 +2391,7 @@ declare namespace media { * Return by promise. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since 12 */ setVideoWindowSize(width: number, height: number) : Promise; @@ -2312,7 +2415,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ url?: string; @@ -2333,7 +2437,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fdSrc?: AVFileDescriptor; @@ -2354,7 +2459,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dataSrc?: AVDataSrcDescriptor; @@ -2369,7 +2475,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ loop: boolean; @@ -2387,7 +2494,8 @@ declare namespace media { * @type { ?audio.InterruptMode } * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ audioInterruptMode?: audio.InterruptMode; @@ -2405,7 +2513,8 @@ declare namespace media { * @type { ?audio.AudioRendererInfo } * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ audioRendererInfo?: audio.AudioRendererInfo; @@ -2430,14 +2539,15 @@ declare namespace media { */ /** * Current playback position. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly currentTime: number; + readonly currentTime: int; /** * Playback duration, When the data source does not support seek, it returns - 1, such as a live broadcast scenario. @@ -2452,14 +2562,15 @@ declare namespace media { */ /** * Playback duration, When the data source does not support seek, it returns - 1, such as a live broadcast scenario. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly duration: number; + readonly duration: int; /** * Playback state. @@ -2473,7 +2584,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly state: AVPlayerState; @@ -2494,7 +2606,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ surfaceId?: string; @@ -2505,14 +2618,15 @@ declare namespace media { */ /** * Video width, valid after prepared. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly width: number; + readonly width: int; /** * Video height, valid after prepared. @@ -2521,14 +2635,15 @@ declare namespace media { */ /** * Video height, valid after prepared. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly height: number; + readonly height: int; /** * Video scale type. By default, the {@link #VIDEO_SCALE_TYPE_FIT} will be used, for more @@ -2543,7 +2658,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoScaleType?: VideoScaleType; @@ -2559,7 +2675,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ setSpeed(speed: PlaybackSpeed): void; @@ -2636,7 +2753,8 @@ declare namespace media { * @param { Callback> } callback - Callback used to listen for the mediaKeySystemInfoUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'mediaKeySystemInfoUpdate', callback: Callback>): void; @@ -2653,7 +2771,8 @@ declare namespace media { * @param { Callback> } callback - Callback for event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'mediaKeySystemInfoUpdate', callback?: Callback>): void; @@ -2679,7 +2798,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'stateChange', callback: OnAVPlayerStateChangeHandle): void; /** @@ -2702,26 +2822,28 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'stateChange', callback?: OnAVPlayerStateChangeHandle): void; /** * Register listens for media playback volumeChange event. * @param { 'volumeChange' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback volume event. + * @param { Callback } callback - Callback used to listen for the playback volume event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Register listens for media playback volumeChange event. * @param { 'volumeChange' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback volume event. + * @param { Callback } callback - Callback used to listen for the playback volume event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'volumeChange', callback: Callback): void; + on(type: 'volumeChange', callback: Callback): void; /** * Unregister listens for media playback volumeChange event. * @param { 'volumeChange' } type - Type of the playback event to listen for. @@ -2731,12 +2853,13 @@ declare namespace media { /** * Unregister listens for media playback volumeChange event. * @param { 'volumeChange' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback volume event. + * @param { Callback } callback - Callback used to listen for the playback volume event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'volumeChange', callback?: Callback): void; + off(type: 'volumeChange', callback?: Callback): void; /** * Register listens for media playback endOfStream event. * @param { 'endOfStream' } type - Type of the playback event to listen for. @@ -2751,7 +2874,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'endOfStream', callback: Callback): void; /** @@ -2766,20 +2890,21 @@ declare namespace media { * @param { Callback } callback - Callback used to listen for the playback end of stream. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'endOfStream', callback?: Callback): void; /** * Register listens for media playback seekDone event. * @param { 'seekDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback seekDone event. + * @param { Callback } callback - Callback used to listen for the playback seekDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Register listens for media playback seekDone event. * @param { 'seekDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback seekDone event. + * @param { Callback } callback - Callback used to listen for the playback seekDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 @@ -2787,13 +2912,14 @@ declare namespace media { /** * Register listens for media playback seekDone event. * @param { 'seekDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback seekDone event. + * @param { Callback } callback - Callback used to listen for the playback seekDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'seekDone', callback: Callback): void; + on(type: 'seekDone', callback: Callback): void; /** * Unregister listens for media playback seekDone event. * @param { 'seekDone' } type - Type of the playback event to listen for. @@ -2810,30 +2936,32 @@ declare namespace media { /** * Unregister listens for media playback seekDone event. * @param { 'seekDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback seekDone event. + * @param { Callback } callback - Callback used to listen for the playback seekDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'seekDone', callback?: Callback): void; + off(type: 'seekDone', callback?: Callback): void; /** * Register listens for media playback speedDone event. * @param { 'speedDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback speedDone event. + * @param { Callback } callback - Callback used to listen for the playback speedDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Register listens for media playback speedDone event. * @param { 'speedDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback speedDone event. + * @param { Callback } callback - Callback used to listen for the playback speedDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'speedDone', callback: Callback): void; + on(type: 'speedDone', callback: Callback): void; /** * Unregister listens for media playback speedDone event. * @param { 'speedDone' } type - Type of the playback event to listen for. @@ -2843,28 +2971,30 @@ declare namespace media { /** * Unregister listens for media playback speedDone event. * @param { 'speedDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback speedDone event. + * @param { Callback } callback - Callback used to listen for the playback speedDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'speedDone', callback?: Callback): void; + off(type: 'speedDone', callback?: Callback): void; /** * Register listens for media playback setBitrateDone event. * @param { 'bitrateDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. + * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Register listens for media playback setBitrateDone event. * @param { 'bitrateDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. + * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'bitrateDone', callback: Callback): void; + on(type: 'bitrateDone', callback: Callback): void; /** * Unregister listens for media playback setBitrateDone event. * @param { 'bitrateDone' } type - Type of the playback event to listen for. @@ -2874,22 +3004,23 @@ declare namespace media { /** * Unregister listens for media playback setBitrateDone event. * @param { 'bitrateDone' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. + * @param { Callback } callback - Callback used to listen for the playback setBitrateDone event. * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'bitrateDone', callback?: Callback): void; + off(type: 'bitrateDone', callback?: Callback): void; /** * Register listens for media playback timeUpdate event. * @param { 'timeUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. + * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Register listens for media playback timeUpdate event. * @param { 'timeUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. + * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice * @since 11 @@ -2897,13 +3028,14 @@ declare namespace media { /** * Register listens for media playback timeUpdate event. * @param { 'timeUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. + * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'timeUpdate', callback: Callback): void; + on(type: 'timeUpdate', callback: Callback): void; /** * Unregister listens for media playback timeUpdate event. * @param { 'timeUpdate' } type - Type of the playback event to listen for. @@ -2920,30 +3052,32 @@ declare namespace media { /** * Unregister listens for media playback timeUpdate event. * @param { 'timeUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. + * @param { Callback } callback - Callback used to listen for the playback timeUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'timeUpdate', callback?: Callback): void; + off(type: 'timeUpdate', callback?: Callback): void; /** * Register listens for media playback durationUpdate event. * @param { 'durationUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. + * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @since 9 */ /** * Register listens for media playback durationUpdate event. * @param { 'durationUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. + * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'durationUpdate', callback: Callback): void; + on(type: 'durationUpdate', callback: Callback): void; /** * Unregister listens for media playback durationUpdate event. * @param { 'durationUpdate' } type - Type of the playback event to listen for. @@ -2953,12 +3087,13 @@ declare namespace media { /** * Unregister listens for media playback durationUpdate event. * @param { 'durationUpdate' } type - Type of the playback event to listen for. - * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. + * @param { Callback } callback - Callback used to listen for the playback durationUpdate event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'durationUpdate', callback?: Callback): void; + off(type: 'durationUpdate', callback?: Callback): void; /** * Register listens for video playback buffering events. @@ -2976,7 +3111,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'bufferingUpdate', callback: OnBufferingUpdateHandler): void; @@ -2995,7 +3131,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'bufferingUpdate', callback?: OnBufferingUpdateHandler): void; /** @@ -3011,7 +3148,8 @@ declare namespace media { * @param { Callback } callback - Callback used to listen for the playback event return . * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'startRenderFrame', callback: Callback): void; /** @@ -3025,7 +3163,8 @@ declare namespace media { * @param { 'startRenderFrame' } type - Type of the playback event to listen for. * @param { Callback } callback - Callback used to listen for the playback event return . * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'startRenderFrame', callback?: Callback): void; @@ -3043,7 +3182,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'videoSizeChange', callback: OnVideoSizeChangeHandler): void; /** @@ -3059,7 +3199,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'videoSizeChange', callback?: OnVideoSizeChangeHandler): void; /** @@ -3076,7 +3217,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'audioInterrupt', callback: Callback): void; /** @@ -3092,7 +3234,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'audioInterrupt', callback?: Callback): void; /** @@ -3107,13 +3250,14 @@ declare namespace media { * Register listens for available bitrate list collect completed events for HLS protocol stream playback. * This event will be reported after the {@link #prepare} called. * @param { 'availableBitrates' } type - Type of the playback event to listen for. - * @param { Callback> } callback - Callback used to listen for the playback event return available bitrate list. + * @param { Callback> } callback - Callback used to listen for the playback event return available bitrate list. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'availableBitrates', callback: Callback>): void; + on(type: 'availableBitrates', callback: Callback>): void; /** * Unregister listens for available bitrate list collect completed events for HLS protocol stream playback. * This event will be reported after the {@link #prepare} called. @@ -3125,13 +3269,14 @@ declare namespace media { * Unregister listens for available bitrate list collect completed events for HLS protocol stream playback. * This event will be reported after the {@link #prepare} called. * @param { 'availableBitrates' } type - Type of the playback event to listen for. - * @param { Callback> } callback - Callback used to listen for the playback event return available bitrate list. + * @param { Callback> } callback - Callback used to listen for the playback event return available bitrate list. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'availableBitrates', callback?: Callback>): void; + off(type: 'availableBitrates', callback?: Callback>): void; /** * Register listens for playback error events. * @param { 'error' } type - Type of the playback error event to listen for. @@ -3187,7 +3332,7 @@ declare namespace media { /** * Register listens for playback error events. * @param { 'error' } type - Type of the playback error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the playback error event. + * @param { ErrorCallback } callback - Callback used to listen for the playback error event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 801 - Capability not supported. @@ -3210,9 +3355,11 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 + * @permission */ - on(type: 'error', callback: ErrorCallback): void; + on(type: 'error', callback: ErrorCallback): void; /** * Unregister listens for playback error events. * @param { 'error' } type - Type of the playback error event to listen for. @@ -3229,13 +3376,14 @@ declare namespace media { /** * Unregister listens for playback error events. * @param { 'error' } type - Type of the playback error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the playback error event. + * @param { ErrorCallback } callback - Callback used to listen for the playback error event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'error', callback?: ErrorCallback): void; + off(type: 'error', callback?: ErrorCallback): void; /** * Subscribes output device change event callback. @@ -3256,7 +3404,8 @@ declare namespace media { *
2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'audioOutputDeviceChangeWithInfo', callback: Callback): void; @@ -3277,7 +3426,8 @@ declare namespace media { *
2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'audioOutputDeviceChangeWithInfo', callback?: Callback): void; @@ -3287,7 +3437,8 @@ declare namespace media { * @param { Callback } callback - Callback used to listen subtitle update event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'subtitleUpdate', callback: Callback): void @@ -3297,7 +3448,8 @@ declare namespace media { * @param { Callback } callback - Callback used to listen subtitle update event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'subtitleUpdate', callback?: Callback): void @@ -3307,7 +3459,8 @@ declare namespace media { * @param { OnTrackChangeHandler } callback - Callback used to listen track change event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'trackChange', callback: OnTrackChangeHandler): void @@ -3317,7 +3470,8 @@ declare namespace media { * @param { OnTrackChangeHandler } callback - Callback used to listen track change event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'trackChange', callback?: OnTrackChangeHandler): void @@ -3327,7 +3481,8 @@ declare namespace media { * @param { Callback> } callback - Callback used to listen trackinfo update event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'trackInfoUpdate', callback: Callback>): void @@ -3337,7 +3492,8 @@ declare namespace media { * @param { Callback> } callback - Callback used to listen trackinfo update event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'trackInfoUpdate', callback?: Callback>): void @@ -3345,46 +3501,50 @@ declare namespace media { * Subscrips listener for audio playback amplitude update event. * In each event, an array of amplitude is reported, large index indicates closer to current time. * @param { 'amplitudeUpdate' } type - Type of the event to listen for. - * @param { Callback> } callback - Callback used to listen amplitude update event. + * @param { Callback> } callback - Callback used to listen amplitude update event. * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'amplitudeUpdate', callback: Callback>): void + on(type: 'amplitudeUpdate', callback: Callback>): void /** * UnSubscrips listener for audio playback amplitude update event * @param { 'amplitudeUpdate' } type - Type of the event to listen for. - * @param { Callback> } callback - Callback used to listen amplitude update event. + * @param { Callback> } callback - Callback used to listen amplitude update event. * @syscap SystemCapability.Multimedia.Media.AVPlayer - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'amplitudeUpdate', callback?: Callback>): void + off(type: 'amplitudeUpdate', callback?: Callback>): void /** * Subscribes listener for video SEI message event, only for live video streaming. * Call before the {@link #prepare}, repeated invocation overwrites the last subscribed callback and payload types. * * @param { 'seiMessageReceived' } type - Type of the playback event to listen for. - * @param { Array } payloadTypes - The subscribed payload types of the SEI message. + * @param { Array } payloadTypes - The subscribed payload types of the SEI message. * @param { OnSeiMessageHandle } callback - Callback to listen SEI message event with subscribed payload types. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type: 'seiMessageReceived', payloadTypes: Array, callback: OnSeiMessageHandle): void; + on(type: 'seiMessageReceived', payloadTypes: Array, callback: OnSeiMessageHandle): void; /** * Unsubscribes listener for video SEI message event. * @param { 'seiMessageReceived' } type - Type of the playback event to listen for. - * @param { Array } payloadTypes - The payload types of the SEI message. + * @param { Array } payloadTypes - The payload types of the SEI message. * Null means unsubscribe all payload types. * @param { OnSeiMessageHandle } callback - Callback to listen SEI message event with subscribed payload types. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'seiMessageReceived', payloadTypes?: Array, callback?: OnSeiMessageHandle): void; + off(type: 'seiMessageReceived', payloadTypes?: Array, callback?: OnSeiMessageHandle): void; /** * Subscribes listener for super-resolution status changed event. @@ -3392,7 +3552,8 @@ declare namespace media { * @param { OnSuperResolutionChanged } callback - Callback used to listen for the super-resolution changed event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ on(type:'superResolutionChanged', callback: OnSuperResolutionChanged): void; @@ -3402,7 +3563,8 @@ declare namespace media { * @param { OnSuperResolutionChanged } callback - Callback used to listen for the super-resolution changed event. * @syscap SystemCapability.Multimedia.Media.AVPlayer * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ off(type:'superResolutionChanged', callback?: OnSuperResolutionChanged): void; } @@ -3423,6 +3585,16 @@ declare namespace media { [key:string]: Object; } + /** + * Provides the container definition for media description key-value pairs. + * + * @typedef { Record } + * @syscap SystemCapability.Multimedia.Media.Core + * @since 20 + * @arkts 1.2 + */ + type PlaybackInfo = Record; + /** * Enumerates statistics info keys for player. * @@ -3582,7 +3754,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum BufferingInfoType { /** @@ -3595,7 +3768,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BUFFERING_START = 1, @@ -3609,7 +3783,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BUFFERING_END = 2, @@ -3623,7 +3798,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BUFFERING_PERCENT = 3, @@ -3637,7 +3813,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CACHED_DURATION = 4, } @@ -3790,7 +3967,8 @@ declare namespace media { * @typedef MediaSourceLoadingRequest * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface MediaSourceLoadingRequest { /** @@ -3798,7 +3976,8 @@ declare namespace media { * @type { string } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ url: string; @@ -3816,14 +3995,14 @@ declare namespace media { * @param { number } uuid - label the resource handle. * @param { number } offset - current media data position from start of the source. * @param { ArrayBuffer } buffer - media data buffer which respond to the player. - * @returns { number } - accept bytes for current read. The value less than zero means failed. + * @returns { int } - accept bytes for current read. The value less than zero means failed. * - 2, means player need current data any more, the client should stop current read process. * - 3, means player buffer is full, the client should wait for next read. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice * @since 18 */ - respondData(uuid: number, offset: number, buffer: ArrayBuffer): number; + respondData(uuid: number, offset: number, buffer: ArrayBuffer): int; /** * The interface for application used to send respond header to AVPlayer @@ -3853,7 +4032,8 @@ declare namespace media { * @typedef MediaStream * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface MediaStream { /** @@ -3861,36 +4041,40 @@ declare namespace media { * @type { string } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ url: string; /** * video width. - * @type { number } + * @type { long } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - width: number; + width: long; /** * video height. - * @type { number } + * @type { long } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - height: number; + height: long; /** * biterate of this mediaStream. - * @type { number } + * @type { long } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - bitrate: number; + bitrate: long; } /** @@ -4070,7 +4254,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVFileDescriptor { /** @@ -4089,13 +4274,14 @@ declare namespace media { /** * The file descriptor of audio or video source from file system. The caller * is responsible to close the file descriptor. - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - fd: number + fd: int /** * The offset into the file where the data to be read, in bytes. By default, @@ -4113,13 +4299,14 @@ declare namespace media { /** * The offset into the file where the data to be read, in bytes. By default, * the offset is zero. - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - offset?: number + offset?: long /** * The length in bytes of the data to be read. By default, the length is the @@ -4137,13 +4324,14 @@ declare namespace media { /** * The length in bytes of the data to be read. By default, the length is the * rest of bytes in the file from the offset. - * @type { ?number } + * @type { ?long } * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - length?: number + length?: long } /** @@ -4171,7 +4359,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVDataSrcDescriptor { /** @@ -4190,13 +4379,14 @@ declare namespace media { /** * Size of the file, -1 means the file size is unknown, in this case, * seek and setSpeed can't be executed, loop can't be set, and can't replay. - * @type { number } + * @type { long } * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - fileSize: number; + fileSize: long; /** * Callback function implemented by users, which is used to fill data. * buffer - The buffer need to fill. @@ -4230,9 +4420,10 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - callback: (buffer: ArrayBuffer, length: number, pos?: number) => number; + callback: (buffer: ArrayBuffer, length: long, pos?: long) => int; } /** @@ -4242,31 +4433,35 @@ declare namespace media { * @typedef SubtitleInfo * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface SubtitleInfo { /** * Duration of the text to be displayed, as milliseconds. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - duration?: number; + duration?: int; /** * Display start time of the text, as milliseconds. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - startTime?: number; + startTime?: int; /** * Text information of current update event. * @type { ?string } * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ text?: string; } @@ -4499,13 +4694,13 @@ declare namespace media { /** * Listens for playback error events. * @param { 'error' } type - Type of the playback error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the playback error event. + * @param { ErrorCallback } callback - Callback used to listen for the playback error event. * @syscap SystemCapability.Multimedia.Media.AudioPlayer * @since 6 * @deprecated since 9 * @useinstead ohos.multimedia.media/media.AVPlayer#event:error */ - on(type: 'error', callback: ErrorCallback): void; + on(type: 'error', callback: ErrorCallback): void; } /** @@ -4520,7 +4715,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type AVRecorderState = 'idle' | 'prepared' | 'started' | 'paused' | 'stopped' | 'released' | 'error'; @@ -4533,7 +4729,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type OnAVRecorderStateChangeHandler = (state: AVRecorderState, reason: StateChangeReason) => void; @@ -4553,7 +4750,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVRecorder { /** @@ -4581,7 +4779,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(config: AVRecorderConfig, callback: AsyncCallback): void; @@ -4610,7 +4809,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(config: AVRecorderConfig): Promise; @@ -4643,7 +4843,8 @@ declare namespace media { * @throws { BusinessError } 5400103 - IO error. Return by callback. * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getInputSurface(callback: AsyncCallback): void; @@ -4654,7 +4855,8 @@ declare namespace media { * @throws { BusinessError } 5400103 - IO error. Return by promise. * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ getInputSurface(): Promise; @@ -4768,7 +4970,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(callback: AsyncCallback): void; @@ -4790,7 +4993,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(): Promise; @@ -4854,7 +5058,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(callback: AsyncCallback): void; @@ -4876,7 +5081,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(): Promise; @@ -4895,7 +5101,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reset(callback: AsyncCallback): void; @@ -4914,7 +5121,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reset(): Promise; @@ -4931,7 +5139,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; @@ -4949,7 +5158,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; @@ -5027,7 +5237,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ readonly state: AVRecorderState; @@ -5038,7 +5249,8 @@ declare namespace media { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3.Parameter verification failed. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'audioCapturerChange', callback: Callback): void; @@ -5049,7 +5261,8 @@ declare namespace media { * @throws { BusinessError } 5400103 - IO error. Return by callback. * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'photoAssetAvailable', callback: Callback): void; /** @@ -5070,7 +5283,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'stateChange', callback: OnAVRecorderStateChangeHandler): void; @@ -5110,7 +5324,7 @@ declare namespace media { /** * Listens for recording error events. * @param { 'error' } type - Type of the recording error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the recorder error event. + * @param { ErrorCallback } callback - Callback used to listen for the recorder error event. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified. *
2. Incorrect parameter types. 3.Parameter verification failed. @@ -5125,9 +5339,11 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + * @permission */ - on(type: 'error', callback: ErrorCallback): void; + on(type: 'error', callback: ErrorCallback): void; /** * Cancel Listens for recording stateChange events. @@ -5142,7 +5358,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'stateChange', callback?: OnAVRecorderStateChangeHandler): void; @@ -5155,13 +5372,14 @@ declare namespace media { /** * Cancel Listens for recording error events. * @param { 'error' } type - Type of the recording error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the recorder error event. + * @param { ErrorCallback } callback - Callback used to listen for the recorder error event. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'error', callback?: ErrorCallback): void; + off(type: 'error', callback?: ErrorCallback): void; /** * Cancel Listens for recording audioCapturerChange events. @@ -5174,7 +5392,8 @@ declare namespace media { * @param { 'audioCapturerChange' } type - Type of the audioCapturerChange event to listen for. * @param { Callback } callback - Callback used to listen device change event. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'audioCapturerChange', callback?: Callback): void; @@ -5183,7 +5402,8 @@ declare namespace media { * @param { 'photoAssetAvailable' } type - Type of the recording event to listen for. * @param { Callback } callback - Callback used to listen for the photo asset event. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'photoAssetAvailable', callback?: Callback): void; } @@ -5303,7 +5523,8 @@ declare namespace media { * @typedef Location * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface Location { /** @@ -5313,12 +5534,13 @@ declare namespace media { */ /** * Latitude. - * @type { number } + * @type { double } * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - latitude: number; + latitude: double; /** * Longitude. @@ -5327,12 +5549,13 @@ declare namespace media { */ /** * Longitude. - * @type { number } + * @type { double } * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - longitude: number; + longitude: double; } /** * Set configures of a watermark to AVRecorder. The position starts at top left corner. @@ -5485,7 +5708,7 @@ declare namespace media { * @param { AudioRecorderConfig } config - Recording parameters. * @throws { BusinessError } 201 - permission denied. * @syscap SystemCapability.Multimedia.Media.AudioRecorder - * @since 12 + * @since 6 * @deprecated since 9 * @useinstead ohos.multimedia.media/media.AVRecorder#prepare */ @@ -5561,13 +5784,13 @@ declare namespace media { /** * Listens for audio recording error events. * @param { 'error' } type - Type of the audio recording error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the audio recording error event. + * @param { ErrorCallback } callback - Callback used to listen for the audio recording error event. * @syscap SystemCapability.Multimedia.Media.AudioRecorder * @since 6 * @deprecated since 9 * @useinstead ohos.multimedia.media/media.AVRecorder#on */ - on(type: 'error', callback: ErrorCallback): void; + on(type: 'error', callback: ErrorCallback): void; } /** @@ -5577,7 +5800,8 @@ declare namespace media { * @typedef { 'idle' | 'prepared' | 'playing' | 'paused' | 'stopped' | 'error' } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ type VideoRecordState = 'idle' | 'prepared' | 'playing' | 'paused' | 'stopped' | 'error'; @@ -5589,7 +5813,8 @@ declare namespace media { * @typedef VideoRecorder * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface VideoRecorder { /** @@ -5619,7 +5844,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(config: VideoRecorderConfig, callback: AsyncCallback): void; /** @@ -5649,7 +5875,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(config: VideoRecorderConfig): Promise; /** @@ -5671,7 +5898,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getInputSurface(callback: AsyncCallback): void; /** @@ -5693,7 +5921,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getInputSurface(): Promise; /** @@ -5759,7 +5988,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(callback: AsyncCallback): void; /** @@ -5781,7 +6011,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(): Promise; /** @@ -5847,7 +6078,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(callback: AsyncCallback): void; /** @@ -5869,7 +6101,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(): Promise; /** @@ -5887,7 +6120,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(callback: AsyncCallback): void; /** @@ -5905,7 +6139,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; /** @@ -5929,7 +6164,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by callback. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reset(callback: AsyncCallback): void; /** @@ -5953,7 +6189,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ reset(): Promise; /** @@ -5968,6 +6205,7 @@ declare namespace media { */ /** * Listens for video recording error events. + * @permission * @param { 'error' } type - Type of the video recording error event to listen for. * @param { ErrorCallback } callback - Callback used to listen for the video recording error event. * @throws { BusinessError } 201 - permission denied. @@ -5986,7 +6224,8 @@ declare namespace media { * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly state: VideoRecordState; } @@ -6015,7 +6254,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum PlaybackSpeed { /** @@ -6028,7 +6268,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_0_75_X = 0, /** @@ -6041,7 +6282,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_1_00_X = 1, /** @@ -6054,7 +6296,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_1_25_X = 2, /** @@ -6067,7 +6310,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_1_75_X = 3, /** @@ -6080,42 +6324,48 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_2_00_X = 4, /** * playback at 0.5x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_0_50_X = 5, /** * playback at 1.5x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_1_50_X = 6, /** * playback at 3.0x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @atomicservice - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_3_00_X = 7, /** * playback at 0.25x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_0_25_X = 8, /** * playback at 0.125x normal speed * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SPEED_FORWARD_0_125_X = 9, } @@ -6519,13 +6769,13 @@ declare namespace media { /** * Listens for playback error events. * @param { 'error' } type - Type of the playback error event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the playback error event. + * @param { ErrorCallback } callback - Callback used to listen for the playback error event. * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @since 8 * @deprecated since 9 * @useinstead ohos.multimedia.media/media.AVPlayer#event:error */ - on(type: 'error', callback: ErrorCallback): void; + on(type: 'error', callback: ErrorCallback): void; } /** @@ -6542,7 +6792,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoScaleType { /** @@ -6559,7 +6810,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_SCALE_TYPE_FIT = 0, @@ -6577,7 +6829,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.VideoPlayer * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_SCALE_TYPE_FIT_CROP = 1, } @@ -6596,7 +6849,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum ContainerFormatType { /** @@ -6608,7 +6862,8 @@ declare namespace media { * A video container format type mp4. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CFT_MPEG_4 = 'mp4', @@ -6622,26 +6877,30 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CFT_MPEG_4A = 'm4a', /** * A audio container format type mp3. * @syscap SystemCapability.Multimedia.Media.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CFT_MP3 = 'mp3', /** * A audio container format type wav. * @syscap SystemCapability.Multimedia.Media.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ CFT_WAV = 'wav', /** * A audio container format type amr. * @syscap SystemCapability.Multimedia.Media.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ CFT_AMR = 'amr', } @@ -6668,7 +6927,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MediaType { /** @@ -6687,7 +6947,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA_TYPE_AUD = 0, /** @@ -6706,14 +6967,16 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA_TYPE_VID = 1, /** * Track is subtitle. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MEDIA_TYPE_SUBTITLE = 2, } @@ -6740,7 +7003,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MediaDescriptionKey { /** @@ -6759,7 +7023,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_TRACK_INDEX = 'track_index', @@ -6779,7 +7044,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_TRACK_TYPE = 'track_type', @@ -6799,7 +7065,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_CODEC_MIME = 'codec_mime', @@ -6819,7 +7086,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_DURATION = 'duration', @@ -6839,7 +7107,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_BITRATE = 'bitrate', @@ -6859,7 +7128,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_WIDTH = 'width', @@ -6879,7 +7149,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_HEIGHT = 'height', @@ -6899,7 +7170,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_FRAME_RATE = 'frame_rate', @@ -6919,7 +7191,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_AUD_CHANNEL_COUNT = 'channel_count', @@ -6939,7 +7212,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_AUD_SAMPLE_RATE = 'sample_rate', @@ -6947,7 +7221,8 @@ declare namespace media { * key for audio bit depth, value type is number * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_AUD_SAMPLE_DEPTH = 'sample_depth', @@ -6955,7 +7230,8 @@ declare namespace media { * Key for language. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_LANGUAGE = 'language', @@ -6963,7 +7239,8 @@ declare namespace media { * Key for track name, value is string. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_TRACK_NAME = 'track_name', @@ -6971,7 +7248,8 @@ declare namespace media { * Key for video hdr type, value type is number. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MD_KEY_HDR_TYPE = 'hdr_type', } @@ -6982,28 +7260,31 @@ declare namespace media { * @typedef VideoRecorderProfile * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface VideoRecorderProfile { /** * Indicates the audio bit rate. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly audioBitrate: number; + readonly audioBitrate: int; /** * Indicates the number of audio channels. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly audioChannels: number; + readonly audioChannels: int; /** * Indicates the audio encoding format. @@ -7011,19 +7292,21 @@ declare namespace media { * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly audioCodec: CodecMimeType; /** * Indicates the audio sampling rate. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly audioSampleRate: number; + readonly audioSampleRate: int; /** * Indicates the output file format. @@ -7031,19 +7314,21 @@ declare namespace media { * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly fileFormat: ContainerFormatType; /** * Indicates the video bit rate. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly videoBitrate: number; + readonly videoBitrate: int; /** * Indicates the video encoding format. @@ -7051,39 +7336,43 @@ declare namespace media { * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ readonly videoCodec: CodecMimeType; /** * Indicates the video width. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly videoFrameWidth: number; + readonly videoFrameWidth: int; /** * Indicates the video height. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly videoFrameHeight: number; + readonly videoFrameHeight: int; /** * Indicates the video frame rate. - * @type { number } + * @type { int } * @readonly * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly videoFrameRate: number; + readonly videoFrameRate: int; } /** @@ -7100,7 +7389,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AudioSourceType { /** @@ -7112,7 +7402,8 @@ declare namespace media { * Default audio source type. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SOURCE_TYPE_DEFAULT = 0, /** @@ -7125,32 +7416,37 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SOURCE_TYPE_MIC = 1, /** * Source type Voice recognition. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SOURCE_TYPE_VOICE_RECOGNITION = 2, /** * Source type Voice communication. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SOURCE_TYPE_VOICE_COMMUNICATION = 7, /** * Source type Voice message. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SOURCE_TYPE_VOICE_MESSAGE = 10, /** * Source type Camcorder. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_SOURCE_TYPE_CAMCORDER = 13, } @@ -7168,7 +7464,8 @@ declare namespace media { * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum VideoSourceType { /** @@ -7180,7 +7477,8 @@ declare namespace media { * Surface raw data. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_SOURCE_TYPE_SURFACE_YUV = 0, /** @@ -7192,7 +7490,8 @@ declare namespace media { * Surface ES data. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_SOURCE_TYPE_SURFACE_ES = 1, } @@ -7203,14 +7502,16 @@ declare namespace media { * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MetaSourceType { /** * Maker info for video. * @syscap SystemCapability.Multimedia.Media.AVRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_MAKER_INFO = 0, } @@ -7220,29 +7521,34 @@ declare namespace media { * * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum FileGenerationMode { /** * file created by app * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ APP_CREATE = 0, /** * file created by system, valid only in camera scene. * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUTO_CREATE_CAMERA_SCENE = 1, } + /** * Provides the video recorder configuration definitions. * * @typedef VideoRecorderConfig * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface VideoRecorderConfig { /** @@ -7250,7 +7556,8 @@ declare namespace media { * @type { ?AudioSourceType } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ audioSourceType?: AudioSourceType; /** @@ -7258,7 +7565,8 @@ declare namespace media { * @type { VideoSourceType } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ videoSourceType: VideoSourceType; /** @@ -7266,7 +7574,8 @@ declare namespace media { * @type { VideoRecorderProfile } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ profile: VideoRecorderProfile; /** @@ -7276,24 +7585,27 @@ declare namespace media { * @type { string } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ url: string; /** * Sets the video rotation angle in output file, and for the file to playback. mp4 support. * the range of rotation angle should be {0, 90, 180, 270}, default is 0. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - rotation?: number; + rotation?: int; /** * geographical location information. * @type { ?Location } * @syscap SystemCapability.Multimedia.Media.VideoRecorder * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ location?: Location; } @@ -7303,14 +7615,16 @@ declare namespace media { * * @typedef EncoderInfo * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface EncoderInfo { /** * encoder format MIME * @type { CodecMimeType } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mimeType: CodecMimeType; @@ -7318,7 +7632,8 @@ declare namespace media { * encoder type, audio or video * @type { string } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: string; @@ -7326,7 +7641,8 @@ declare namespace media { * audio or video encoder bitRate range * @type { ?Range } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bitRate?: Range; @@ -7334,7 +7650,8 @@ declare namespace media { * video encoder frame rate range * @type { ?Range } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ frameRate?: Range; @@ -7342,7 +7659,8 @@ declare namespace media { * video encoder width range * @type { ?Range } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width?: Range; @@ -7350,7 +7668,8 @@ declare namespace media { * video encoder height range * @type { ?Range } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height?: Range; @@ -7358,17 +7677,19 @@ declare namespace media { * audio encoder channel range * @type { ?Range } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ channels?: Range; /** * audio encoder sample rate collection - * @type { ?Array } + * @type { ?Array } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - sampleRate?: Array; + sampleRate?: Array; } /** @@ -7376,24 +7697,27 @@ declare namespace media { * * @typedef Range * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface Range { /** * lower limit of the range - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - min: number; + min: int; /** * upper limit of the range - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - max: number; + max: int; } /** @@ -7410,7 +7734,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVRecorderProfile { /** @@ -7420,13 +7745,14 @@ declare namespace media { */ /** * Indicates the audio bitrate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioBitrate?: number; + audioBitrate?: int; /** * Indicates the number of audio channels. @@ -7435,13 +7761,14 @@ declare namespace media { */ /** * Indicates the number of audio channels. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioChannels?: number; + audioChannels?: int; /** * Indicates the audio encoding format. @@ -7454,7 +7781,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ audioCodec?: CodecMimeType; @@ -7465,13 +7793,14 @@ declare namespace media { */ /** * Indicates the audio sampling rate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioSampleRate?: number; + audioSampleRate?: int; /** * Indicates the output file format. @@ -7484,7 +7813,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fileFormat: ContainerFormatType; @@ -7495,12 +7825,13 @@ declare namespace media { */ /** * Indicates the video bitrate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoBitrate?: number; + videoBitrate?: int; /** * Indicates the video encoding format. @@ -7512,7 +7843,8 @@ declare namespace media { * @type { ?CodecMimeType } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoCodec?: CodecMimeType; @@ -7523,13 +7855,14 @@ declare namespace media { */ /** * Indicates the video width. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoFrameWidth?: number; - + videoFrameWidth?: int; + /** * Indicates the video height. * @syscap SystemCapability.Multimedia.Media.AVRecorder @@ -7537,13 +7870,14 @@ declare namespace media { */ /** * Indicates the video height. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoFrameHeight?: number; - + videoFrameHeight?: int; + /** * Indicates the video frame rate. * @syscap SystemCapability.Multimedia.Media.AVRecorder @@ -7551,12 +7885,13 @@ declare namespace media { */ /** * Indicates the video frame rate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoFrameRate?: number; + videoFrameRate?: int; /** * Whether to record HDR video. @@ -7569,7 +7904,8 @@ declare namespace media { * @type { ?boolean } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ isHdr?: boolean; @@ -7578,7 +7914,8 @@ declare namespace media { * @type { ?boolean } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableTemporalScale?: boolean; @@ -7587,7 +7924,8 @@ declare namespace media { * @type { ?boolean } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @systemapi - * @since 18 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enableStableQualityMode?: boolean } @@ -7606,7 +7944,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVRecorderConfig { /** @@ -7620,7 +7959,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ audioSourceType?: AudioSourceType; /** @@ -7633,7 +7973,8 @@ declare namespace media { * @type { ?VideoSourceType } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoSourceType?: VideoSourceType; /** @@ -7641,7 +7982,8 @@ declare namespace media { * @type { ?Array } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ metaSourceTypes?: Array; /** @@ -7655,7 +7997,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ profile: AVRecorderProfile; /** @@ -7680,7 +8023,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.AVRecorder * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ url?: string; @@ -7694,18 +8038,20 @@ declare namespace media { /** * Sets the video rotation angle in output file, and for the file to playback, mp4 support * the range of rotation angle should be {0, 90, 180, 270}, default is 0. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 12 * @useinstead ohos.multimedia.media/media.AVMetadata#videoOrientation */ - rotation?: number; + rotation?: int; /** * Geographical location information. * @type { ?Location } * @syscap SystemCapability.Multimedia.Media.AVRecorder - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 12 * @useinstead ohos.multimedia.media/media.AVMetadata#location */ @@ -7719,11 +8065,11 @@ declare namespace media { metadata?: AVMetadata; /** * Set the longest duration allowed for current recording. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVRecorder * @since 18 */ - maxDuration?: number; + maxDuration?: int; } /** @@ -7772,6 +8118,18 @@ declare namespace media { [key: string]: Object; } + /** + * Provides the container definition for media description key-value pairs. + * + * @typedef { Record } + * @syscap SystemCapability.Multimedia.Media.Core + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type MediaDescription = Record; + /** * Enumerates seek mode. * @@ -7794,7 +8152,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum SeekMode { /** @@ -7813,7 +8172,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SEEK_NEXT_SYNC = 0, /** @@ -7832,14 +8192,16 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SEEK_PREV_SYNC = 1, /** * Seek to the closest frame of the given timestamp. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SEEK_CLOSEST = 2, /** @@ -7851,7 +8213,8 @@ declare namespace media { * through the on error callback. * @syscap SystemCapability.Multimedia.Media.Core * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SEEK_CONTINUOUS = 3, } @@ -7905,7 +8268,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum CodecMimeType { /** @@ -7917,7 +8281,8 @@ declare namespace media { * H.263 codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_H263 = 'video/h263', /** @@ -7929,7 +8294,8 @@ declare namespace media { * H.264 codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_AVC = 'video/avc', /** @@ -7941,7 +8307,8 @@ declare namespace media { * MPEG2 codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_MPEG2 = 'video/mpeg2', /** @@ -7953,7 +8320,8 @@ declare namespace media { * MPEG4 codec MIME type * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_MPEG4 = 'video/mp4v-es', @@ -7966,7 +8334,8 @@ declare namespace media { * VP8 codec MIME type * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_VP8 = 'video/x-vnd.on2.vp8', @@ -7980,7 +8349,8 @@ declare namespace media { * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_AAC = 'audio/mp4a-latm', @@ -7993,7 +8363,8 @@ declare namespace media { * vorbis codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_VORBIS = 'audio/vorbis', @@ -8006,7 +8377,8 @@ declare namespace media { * flac codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_FLAC = 'audio/flac', @@ -8019,31 +8391,36 @@ declare namespace media { * H.265 codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ VIDEO_HEVC = 'video/hevc', /** * mp3 codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_MP3 = 'audio/mpeg', /** * G711-mulaw codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_G711MU = 'audio/g711mu', /** * AMR_NB codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_AMR_NB = 'audio/3gpp', /** * AMR_WB codec MIME type. * @syscap SystemCapability.Multimedia.Media.Core - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ AUDIO_AMR_WB = 'audio/amr-wb', } @@ -8097,73 +8474,85 @@ declare namespace media { * * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum AVScreenCaptureStateCode { /** * Screen capture started * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_STARTED = 0, /** * Screen capture canceled * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_CANCELED = 1, /** * Screen capture stopped by user * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_STOPPED_BY_USER = 2, /** * Screen capture stopped by interrupt * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_INTERRUPTED_BY_OTHER = 3, /** * Screen capture stopped by phone call * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_STOPPED_BY_CALL = 4, /** * Screen capture microphone not available * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_MIC_UNAVAILABLE = 5, /** * Screen capture microphone is muted by user * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_MIC_MUTED_BY_USER = 6, /** * Screen capture microphone is unmuted by user * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_MIC_UNMUTED_BY_USER = 7, /** * Screen capture enter private scene * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_ENTER_PRIVATE_SCENE = 8, /** * Screen capture exit private scene * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_EXIT_PRIVATE_SCENE = 9, /** * Screen capture stopped by user switches * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STATE_STOPPED_BY_USER_SWITCHES = 10, } @@ -8173,58 +8562,66 @@ declare namespace media { * * @typedef AVScreenCaptureRecordConfig * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVScreenCaptureRecordConfig { /** * Indicates record file descriptor. - * @type { number } + * @type { int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - fd: number; + fd: int; /** * Indicates video frame width. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - frameWidth?: number; + frameWidth?: int; /** * Indicates video frame height. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - frameHeight?: number; + frameHeight?: int; /** * Indicates video bitrate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoBitrate?: number; + videoBitrate?: int; /** * Indicates audio sample rate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioSampleRate?: number; + audioSampleRate?: int; /** * Indicates audio channel count. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioChannelCount?: number; + audioChannelCount?: int; /** * Indicates audio bitrate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioBitrate?: number; + audioBitrate?: int; /** * Indicates AVScreenCaptureRecordPreset, details see @AVScreenCaptureRecordPreset * @type { ?AVScreenCaptureRecordPreset } @@ -8234,11 +8631,12 @@ declare namespace media { preset?: AVScreenCaptureRecordPreset; /** * Indicates the screen to be recorded. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - displayId?: number; + displayId?: int; /** * Indicates the fill mode of video, details see @AVScreenCaptureFillMode * @type { ?AVScreenCaptureFillMode } @@ -8254,7 +8652,8 @@ declare namespace media { * * @typedef AVScreenCaptureRecorder * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVScreenCaptureRecorder { /** @@ -8318,7 +8717,8 @@ declare namespace media { * @throws { BusinessError } 5400103 - IO error. Return by promise. * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; @@ -8327,39 +8727,44 @@ declare namespace media { * @param { 'stateChange' } type - Type of the AVScreenCaptureRecord event to listen for. * @param { Callback } callback - Callback used to listen for the AVScreenCaptureRecord info return. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'stateChange', callback: Callback): void; /** * Listens for AVScreenCaptureRecord info callback. * @param { 'error' } type - Type of the AVScreenCaptureRecord event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the AVScreenCaptureRecord error return. + * @param { ErrorCallback } callback - Callback used to listen for the AVScreenCaptureRecord error return. * @throws { BusinessError } 201 - permission denied. * @throws { BusinessError } 5400103 - IO error. Return by ErrorCallback. * @throws { BusinessError } 5400105 - Service died. Return by ErrorCallback. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 + * @permission */ - on(type: 'error', callback: ErrorCallback): void; + on(type: 'error', callback: ErrorCallback): void; /** * Unregister listens for AVScreenCaptureRecord info callback. * @param { 'stateChange' } type - Type of the AVScreenCaptureRecord event to listen for. * @param { Callback } callback - Callback used to listen for the AVScreenCaptureRecord info return. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'stateChange', callback?: Callback): void; /** * Unregister listens for AVScreenCaptureRecord error callback. * @param { 'error' } type - Type of the AVScreenCaptureRecord event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the AVScreenCaptureRecord error return. + * @param { ErrorCallback } callback - Callback used to listen for the AVScreenCaptureRecord error return. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type: 'error', callback?: ErrorCallback): void; + off(type: 'error', callback?: ErrorCallback): void; } /** @@ -8367,22 +8772,25 @@ declare namespace media { * * @typedef AVTranscoderConfig * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVTranscoderConfig { /** * Indicates the audio bitrate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - audioBitrate?: number; + audioBitrate?: int; /** * Indicates the audio encoding format. * @type { ?CodecMimeType } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ audioCodec?: CodecMimeType; @@ -8390,41 +8798,46 @@ declare namespace media { * Indicates the output file format. * @type { ContainerFormatType } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fileFormat: ContainerFormatType; /** * Indicates the video bitrate. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoBitrate?: number; + videoBitrate?: int; /** * Indicates the video encoding foramt. * @type { ?CodecMimeType } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ videoCodec?: CodecMimeType; /** * Indicates the video width. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoFrameWidth?: number; + videoFrameWidth?: int; /** * Indicates the video height. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - videoFrameHeight?: number; + videoFrameHeight?: int; } /** @@ -8434,14 +8847,16 @@ declare namespace media { * * @typedef AVTranscoder * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface AVTranscoder { /** * Source media file descriptor. Mainstream media formats are supported. * @type { AVFileDescriptor } * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ fdSrc: AVFileDescriptor; @@ -8462,7 +8877,8 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. Return by promise. * @throws { BusinessError } 5400106 - Unsupported format. Returned by promise. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ prepare(config: AVTranscoderConfig): Promise; @@ -8484,7 +8900,8 @@ declare namespace media { * @throws { BusinessError } 5400103 - IO error. Return by promise. * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ pause(): Promise; @@ -8516,7 +8933,8 @@ declare namespace media { * @throws { BusinessError } 5400102 - Operation not allowed. Return by promise. * @throws { BusinessError } 5400105 - Service died. Return by promise. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ release(): Promise; @@ -8525,14 +8943,15 @@ declare namespace media { * @param { 'complete' } type - Type of the event to listen for. * @param { Callback } callback - Callback used to listen for the complete event. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type:'complete', callback: Callback):void; /** * Register listener for trancoding error event. * @param { 'error' } type - Type of the event to listen for. - * @param { ErrorCallback } callback - Callback used to listen for the error event. + * @param { ErrorCallback } callback - Callback used to listen for the error event. * @throws { BusinessError } 401 - The parameter check failed. * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 5400101 - No memory. @@ -8542,45 +8961,50 @@ declare namespace media { * @throws { BusinessError } 5400105 - Service died. * @throws { BusinessError } 5400106 - Unsupported format. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type:'error', callback: ErrorCallback):void; + on(type:'error', callback: ErrorCallback):void; /** * Register listener for trancoding progressUpdate event. * @param { 'progressUpdate' } type - Type of the event to listen for. - * @param { Callback } callback - Callback used to listen for the progressUpdate event. + * @param { Callback } callback - Callback used to listen for the progressUpdate event. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - on(type:'progressUpdate', callback: Callback):void; + on(type:'progressUpdate', callback: Callback):void; /** * Unregister listener for trancoding complete event. * @param { 'complete' } type - Type of the event to listen for. * @param { Callback } [callback] - Callback used to listen for the complete event. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ off(type:'complete', callback?: Callback):void; /** * Unregister listener for trancoding error event. * @param { 'error' } type - Type of the event to listen for. - * @param { ErrorCallback } [callback] - Callback used to listen for the error event. + * @param { ErrorCallback } [callback] - Callback used to listen for the error event. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type:'error', callback?: ErrorCallback):void; + off(type:'error', callback?: ErrorCallback):void; /** * Unregister listener for trancoding progressUpdate event. * @param { 'progressUpdate' } type - Type of the event to listen for. - * @param { Callback } [callback] - Callback used to listen for the progressUpdate event. + * @param { Callback } [callback] - Callback used to listen for the progressUpdate event. * @syscap SystemCapability.Multimedia.Media.AVTranscoder - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - off(type:'progressUpdate', callback?: Callback):void; + off(type:'progressUpdate', callback?: Callback):void; } /** @@ -8589,21 +9013,24 @@ declare namespace media { * @enum { number } * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ enum ScreenCaptureEvent { /** * Screen capture started * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STARTED = 0, /** * Screen capture stopped * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ SCREENCAPTURE_STOPPED = 1 } @@ -8614,7 +9041,8 @@ declare namespace media { * @typedef ScreenCaptureMonitor * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ interface ScreenCaptureMonitor { /** @@ -8624,7 +9052,8 @@ declare namespace media { * @throws { BusinessError } 202 - Not System App. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'systemScreenRecorder', callback: Callback): void; @@ -8635,7 +9064,8 @@ declare namespace media { * @throws { BusinessError } 202 - Not System App. * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'systemScreenRecorder', callback?: Callback): void; @@ -8645,7 +9075,8 @@ declare namespace media { * @readonly * @syscap SystemCapability.Multimedia.Media.AVScreenCapture * @systemapi - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ readonly isSystemScreenRecorderWorking: boolean; } diff --git a/api/@ohos.multimodalAwareness.metadataBinding.d.ts b/api/@ohos.multimodalAwareness.metadataBinding.d.ts index 83b1f206a45d63369a4284dacd3320e1f89acb0b..7f8d5f4963c7634c2b8dbedc311f64ea359b831f 100644 --- a/api/@ohos.multimodalAwareness.metadataBinding.d.ts +++ b/api/@ohos.multimodalAwareness.metadataBinding.d.ts @@ -26,7 +26,7 @@ import type { Callback } from './@ohos.base'; * @namespace metadataBinding * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ declare namespace metadataBinding { /** @@ -35,12 +35,11 @@ declare namespace metadataBinding { * @param { string } metadata - Coded metadata * @returns { Promise } encoded image * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. File creation failed * @throws { BusinessError } 32100002 - Encode process fail. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @systemapi - * @since 15 + * @since 18 */ function encodeImage(srcImage: image.PixelMap, metadata: string): Promise; @@ -48,13 +47,12 @@ declare namespace metadataBinding { * MetadataBinding provides decode capabilities * @param { image.PixelMap } encodedImage - Encoded image * @returns { Promise } decode result - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. * @throws { BusinessError } 32100001 - Internal handling failed. File read failed. * @throws { BusinessError } 32100003 - Decode process fail. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @systemapi - * @since 15 + * @since 18 */ function decodeImage(encodedImage: image.PixelMap): Promise; @@ -63,22 +61,20 @@ declare namespace metadataBinding { * @param { string } bundleName - Bundle name of a third-party application * @returns { Promise } third-party app callback the meta data * @throws { BusinessError } 202 - Permission check failed. A non-system application uses the system API. - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Obtain metadata failed. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @systemapi - * @since 15 + * @since 18 */ function notifyMetadataBindingEvent(bundleName: string): Promise; /** * set the Metadata to the screenshot app * @param { string } metadata - the Metadata of a Third-Party App - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Set Meta data to screenshot app fail. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ function submitMetadata(metadata: string): void; @@ -87,12 +83,11 @@ declare namespace metadataBinding { * @param { 'operationSubmitMetadata' } type - Event Type * @param { string } bundleName - Bundle name of a third-party application * @param { Callback } callback - Call back the screenshot event - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Service exception. * @throws { BusinessError } 32100004 - Subscribe Failed. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ function on(type: 'operationSubmitMetadata', bundleName: string, callback: Callback): void; @@ -101,14 +96,13 @@ declare namespace metadataBinding { * @param { 'operationSubmitMetadata' } type - Event Type * @param { string } bundleName - Bundle name of a third-party application * @param { Callback } callback - Call back the screenshot event - * @throws { BusinessError } 401 - Parameter error. Parameter verification failed. * @throws { BusinessError } 32100001 - Internal handling failed. Service exception. * @throws { BusinessError } 32100005 - Unsubscribe Failed. * @syscap SystemCapability.MultimodalAwareness.MetadataBinding * @atomicservice - * @since 15 + * @since 18 */ function off(type: 'operationSubmitMetadata', bundleName: string, callback?: Callback): void; } -export default metadataBinding +export default metadataBinding; diff --git a/api/@ohos.multimodalInput.gestureEvent.d.ts b/api/@ohos.multimodalInput.gestureEvent.d.ts index 211ba308a611eb2c17d684c7d62d3771f5203872..254168695ae3670e55c8f6ba9ada86abe6395451 100644 --- a/api/@ohos.multimodalInput.gestureEvent.d.ts +++ b/api/@ohos.multimodalInput.gestureEvent.d.ts @@ -18,19 +18,25 @@ * @kit InputKit */ +/*** if arkts 1.2 */ +import { Touch } from './@ohos.multimodalInput.touchEvent'; +/*** endif */ + /** * Pinch event on touchPad * * @interface Pinch * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface Pinch { /** * Action type * @type { ActionType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ActionType; @@ -38,7 +44,8 @@ export declare interface Pinch { * scale * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ scale: number; } @@ -48,7 +55,8 @@ export declare interface Pinch { * * @interface Rotate * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface Rotate { /** @@ -56,7 +64,8 @@ export declare interface Rotate { * * @type { ActionType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ActionType; @@ -65,7 +74,8 @@ export declare interface Rotate { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ angle: number; } @@ -75,14 +85,16 @@ export declare interface Rotate { * * @interface ThreeFingersSwipe * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface ThreeFingersSwipe { /** * Action type * @type { ActionType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ActionType; @@ -90,7 +102,8 @@ export declare interface ThreeFingersSwipe { * Coordinate x * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -98,7 +111,8 @@ export declare interface ThreeFingersSwipe { * Coordinate y * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -108,14 +122,16 @@ export declare interface ThreeFingersSwipe { * * @interface FourFingersSwipe * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface FourFingersSwipe { /** * Action type * @type { ActionType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ActionType; @@ -123,7 +139,8 @@ export declare interface FourFingersSwipe { * Coordinate x * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -131,7 +148,8 @@ export declare interface FourFingersSwipe { * Coordinate y * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -142,7 +160,8 @@ export declare interface FourFingersSwipe { * @interface SwipeInward * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface SwipeInward { /** @@ -150,7 +169,8 @@ export declare interface SwipeInward { * @type { ActionType } * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ActionType; @@ -159,7 +179,8 @@ export declare interface SwipeInward { * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ x: number; @@ -168,7 +189,8 @@ export declare interface SwipeInward { * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ y: number; } @@ -178,7 +200,8 @@ export declare interface SwipeInward { * * @interface ThreeFingersTap * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface ThreeFingersTap { /** @@ -186,7 +209,8 @@ export declare interface ThreeFingersTap { * * @type { ActionType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ActionType; } @@ -197,7 +221,8 @@ export declare interface ThreeFingersTap { * @interface TouchGestureEvent * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface TouchGestureEvent { /** @@ -206,7 +231,8 @@ export declare interface TouchGestureEvent { * @type { TouchGestureAction } * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ action: TouchGestureAction; /** @@ -215,7 +241,8 @@ export declare interface TouchGestureEvent { * @type { Touch[] } * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ touches: Touch[]; } @@ -226,7 +253,8 @@ export declare interface TouchGestureEvent { * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum TouchGestureAction { /** @@ -234,7 +262,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SWIPE_DOWN = 0, /** @@ -242,7 +271,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SWIPE_UP, /** @@ -250,7 +280,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SWIPE_LEFT, /** @@ -258,7 +289,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ SWIPE_RIGHT, /** @@ -266,7 +298,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ PINCH_CLOSED, /** @@ -274,7 +307,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ PINCH_OPENED, /** @@ -282,7 +316,8 @@ export declare enum TouchGestureAction { * * @syscap SystemCapability.MultimodalInput.Input.Core * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ GESTURE_END } @@ -292,14 +327,16 @@ export declare enum TouchGestureAction { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum ActionType { /** * Cancel of the gesture * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 0, @@ -307,7 +344,8 @@ export declare enum ActionType { * Begin of the gesture * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ BEGIN = 1, @@ -315,7 +353,8 @@ export declare enum ActionType { * Update of the gesture * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ UPDATE = 2, @@ -323,7 +362,8 @@ export declare enum ActionType { * End of the gesture * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ END = 3 } \ No newline at end of file diff --git a/api/@ohos.multimodalInput.inputConsumer.d.ts b/api/@ohos.multimodalInput.inputConsumer.d.ts index d8c36bfdcda789d8e711926ffc04d0e61ed4626a..1762f29ca4cd6269a51bbfd3b2ba83e7eef6cb99 100644 --- a/api/@ohos.multimodalInput.inputConsumer.d.ts +++ b/api/@ohos.multimodalInput.inputConsumer.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (C) 2021-2023 Huawei Device Co., Ltd. + * 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 @@ -26,7 +26,8 @@ import { KeyEvent } from './@ohos.multimodalInput.keyEvent'; * * @namespace inputConsumer * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace inputConsumer { /** @@ -35,28 +36,31 @@ declare namespace inputConsumer { * @interface KeyOptions * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface KeyOptions { /** * The pre-keys that want to subscribe or unsubscribe. * - * @type { Array } + * @type { Array } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - preKeys: Array; + preKeys: Array; /** * The post position key that want to subscribe or unsubscribe. * - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - finalKey: number; + finalKey: int; /** * The final key press down or up. @@ -64,19 +68,21 @@ declare namespace inputConsumer { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ isFinalKeyDown: boolean; /** * Duration of final key press. * - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ - finalKeyDownDuration: number; + finalKeyDownDuration: int; /** * Whether to report repeated key events. By default, the value is true if it is left unspecified. @@ -84,7 +90,8 @@ declare namespace inputConsumer { * @type { ?boolean } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ isRepeat?: boolean; } @@ -94,33 +101,37 @@ declare namespace inputConsumer { * * @typedef HotkeyOptions * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ interface HotkeyOptions { /** * Defines modifier keys. One or two modifier keys are supported. * - * @type { Array } + * @type { Array } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - preKeys: Array; + preKeys: Array; /** * Defines modified keys. * - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - finalKey: number; + finalKey: int; /** * Whether to report repeated key events. By default, the value is true if it is left unspecified. * * @type { ?boolean } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ isRepeat?: boolean; } @@ -130,34 +141,38 @@ declare namespace inputConsumer { * * @typedef KeyPressedConfig * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ interface KeyPressedConfig { /** * Key value. Currently listening is supported only for KEYCODE_VOLUME_UP and KEYCODE_VOLUME_DOWN keys. * - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ - key: number; + key: int; /** * Key event type. The value 1 indicates key press and the value 2 indicates key release. Currently * listening is supported only for key press events. * - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ - action: number; + action: int; /** * Whether to report repeated key events. * * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ isRepeat: boolean; } @@ -204,7 +219,8 @@ declare namespace inputConsumer { *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'key', keyOptions: KeyOptions, callback: Callback): void; @@ -231,7 +247,8 @@ declare namespace inputConsumer { *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputConsumer * @systemapi hide for inner use - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'key', keyOptions: KeyOptions, callback?: Callback): void; @@ -290,9 +307,10 @@ declare namespace inputConsumer { * @throws { BusinessError } 4200002 - The hotkey has been used by the system. * @throws { BusinessError } 4200003 - The hotkey has been subscribed to by another. * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback: Callback): void + function on(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback: Callback): void; /** * Unsubscribe from hotkey event changes. @@ -304,9 +322,10 @@ declare namespace inputConsumer { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 14 + * @since arkts {'1.1':'14', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback?: Callback): void + function off(type: 'hotkeyChange', hotkeyOptions: HotkeyOptions, callback?: Callback): void; /** * Consumed key events. Only the VolumeUp and VolumeDown keys are supported. When the current application process @@ -319,9 +338,10 @@ declare namespace inputConsumer { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ - function on(type: 'keyPressed', options: KeyPressedConfig, callback: Callback): void + function on(type: 'keyPressed', options: KeyPressedConfig, callback: Callback): void; /** * Cancels consumption of key events. @@ -332,9 +352,10 @@ declare namespace inputConsumer { *
2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.MultimodalInput.Input.InputConsumer - * @since 16 + * @since arkts {'1.1':'16', '1.2':'20'} + * @arkts 1.1&1.2 */ - function off(type: 'keyPressed', callback?: Callback): void + function off(type: 'keyPressed', callback?: Callback): void; } export default inputConsumer; \ No newline at end of file diff --git a/api/@ohos.multimodalInput.inputDevice.d.ts b/api/@ohos.multimodalInput.inputDevice.d.ts index b1ed681edf92a5ff5929223f0f6e8c2453a59766..de79427030cc5421034e199c107f77cf1fcfe495 100644 --- a/api/@ohos.multimodalInput.inputDevice.d.ts +++ b/api/@ohos.multimodalInput.inputDevice.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021-2023 Huawei Device Co., Ltd. + * 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 @@ -18,22 +18,29 @@ * @kit InputKit */ +/*** if arkts 1.1 */ import type { Callback, AsyncCallback } from './@ohos.base'; import type { KeyCode } from './@ohos.multimodalInput.keyCode'; +/*** endif */ +/*** if arkts 1.2 */ +import { Callback, AsyncCallback } from './@ohos.base'; +/*** endif */ /** * The input device management module is configured to obtain an ID and device information of an input device. * * @namespace inputDevice * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace inputDevice { /** * Add or remove device * @typedef { 'add' | 'remove' } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type ChangedType = 'add' | 'remove'; @@ -41,7 +48,8 @@ declare namespace inputDevice { * The type of input device * @typedef { 'keyboard' | 'mouse' | 'touchpad' | 'touchscreen' | 'joystick' | 'trackball' } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type SourceType = 'keyboard' | 'mouse' | 'touchpad' | 'touchscreen' | 'joystick' | 'trackball'; @@ -49,7 +57,8 @@ declare namespace inputDevice { * Axis Type of the input event * @typedef { 'touchmajor'| 'touchminor' | 'orientation' | 'x' | 'y' | 'pressure' | 'toolminor' | 'toolmajor' | 'null' } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type AxisType = 'touchmajor' @@ -139,7 +148,8 @@ declare namespace inputDevice { * * @interface DeviceListener * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface DeviceListener { /** @@ -147,7 +157,8 @@ declare namespace inputDevice { * * @type { ChangedType } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type: ChangedType; @@ -156,7 +167,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: number; } @@ -169,7 +181,8 @@ declare namespace inputDevice { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'change', listener: Callback): void; @@ -192,7 +205,8 @@ declare namespace inputDevice { * * @interface AxisRange * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AxisRange { /** @@ -201,7 +215,8 @@ declare namespace inputDevice { * * @type { SourceType } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ source: SourceType; @@ -210,7 +225,8 @@ declare namespace inputDevice { * * @type { AxisType } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ axis: AxisType; @@ -219,7 +235,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ max: number; @@ -228,7 +245,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ min: number; @@ -237,7 +255,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ fuzz: number; @@ -246,7 +265,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ flat: number; @@ -255,7 +275,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ resolution: number; } @@ -265,7 +286,8 @@ declare namespace inputDevice { * * @interface InputDeviceData * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ interface InputDeviceData { /** @@ -273,7 +295,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -282,7 +305,8 @@ declare namespace inputDevice { * * @type { string } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -292,7 +316,8 @@ declare namespace inputDevice { * * @type { Array } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ sources: Array; @@ -301,7 +326,8 @@ declare namespace inputDevice { * * @type { Array } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 8 + * @since arkts {'1.1':'8', '1.2':'20'} + * @arkts 1.1&1.2 */ axisRanges: Array; @@ -310,7 +336,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ bus: number; @@ -319,7 +346,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ product: number; @@ -328,7 +356,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ vendor: number; @@ -337,7 +366,8 @@ declare namespace inputDevice { * * @type { number } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ version: number; @@ -346,7 +376,8 @@ declare namespace inputDevice { * * @type { string } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ phys: string; @@ -355,7 +386,8 @@ declare namespace inputDevice { * * @type { string } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ uniq: string; } @@ -413,7 +445,8 @@ declare namespace inputDevice { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDeviceList(callback: AsyncCallback>): void; @@ -422,7 +455,8 @@ declare namespace inputDevice { * * @returns { Promise> } * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDeviceList(): Promise>; @@ -434,7 +468,8 @@ declare namespace inputDevice { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDeviceInfo(deviceId: number, callback: AsyncCallback): void; @@ -446,7 +481,8 @@ declare namespace inputDevice { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.InputDevice - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDeviceInfo(deviceId: number): Promise; diff --git a/api/@ohos.multimodalInput.inputEvent.d.ts b/api/@ohos.multimodalInput.inputEvent.d.ts index 65053adb01d293c363d78942fc6601f6b5d864cb..526adc0e24369d85151feb4009b3d29a3977e3a9 100644 --- a/api/@ohos.multimodalInput.inputEvent.d.ts +++ b/api/@ohos.multimodalInput.inputEvent.d.ts @@ -23,7 +23,8 @@ * * @interface InputEvent * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * InputEvent @@ -31,81 +32,92 @@ * @typedef InputEvent * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface InputEvent { /** * Unique event ID generated by the server - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Unique event ID generated by the server - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - id: number; + id: int; /** * ID of the device that reports the input event - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * ID of the device that reports the input event - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - deviceId: number; + deviceId: int; /** * Occurrence time of the input event - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Occurrence time of the input event - * @type { number } + * @type { long } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - actionTime: number; + actionTime: long; /** * ID of the target screen - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * ID of the target screen - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - screenId: number; + screenId: int; /** * ID of the target window - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * ID of the target window - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - windowId: number; + windowId: int; } \ No newline at end of file diff --git a/api/@ohos.multimodalInput.intentionCode.d.ts b/api/@ohos.multimodalInput.intentionCode.d.ts index 79445f8cc2a961ba785b56c8d962f5ff9ba2d96f..ee127fa5db0eb42d848113e48c0b91c0d5c85f5c 100644 --- a/api/@ohos.multimodalInput.intentionCode.d.ts +++ b/api/@ohos.multimodalInput.intentionCode.d.ts @@ -23,7 +23,8 @@ * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * IntentionCode @@ -31,21 +32,24 @@ * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum IntentionCode { /** * INTENTION_UNKNOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_UNKNOWN * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_UNKNOWN = -1, @@ -53,14 +57,16 @@ export declare enum IntentionCode { * INTENTION_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_UP * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_UP = 1, @@ -68,14 +74,16 @@ export declare enum IntentionCode { * INTENTION_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_DOWN = 2, @@ -83,14 +91,16 @@ export declare enum IntentionCode { * INTENTION_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_LEFT = 3, @@ -98,14 +108,16 @@ export declare enum IntentionCode { * INTENTION_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_RIGHT = 4, @@ -113,14 +125,16 @@ export declare enum IntentionCode { * INTENTION_SELECT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_SELECT * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_SELECT = 5, @@ -128,14 +142,16 @@ export declare enum IntentionCode { * INTENTION_ESCAPE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_ESCAPE * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_ESCAPE = 6, @@ -143,14 +159,16 @@ export declare enum IntentionCode { * INTENTION_BACK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_BACK * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_BACK = 7, @@ -158,14 +176,16 @@ export declare enum IntentionCode { * INTENTION_FORWARD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_FORWARD * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_FORWARD = 8, @@ -173,14 +193,16 @@ export declare enum IntentionCode { * INTENTION_MENU * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_MENU * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_MENU = 9, @@ -188,14 +210,16 @@ export declare enum IntentionCode { * INTENTION_PAGE_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_PAGE_UP * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_PAGE_UP = 11, @@ -203,14 +227,16 @@ export declare enum IntentionCode { * INTENTION_PAGE_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_PAGE_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_PAGE_DOWN = 12, @@ -218,14 +244,16 @@ export declare enum IntentionCode { * INTENTION_ZOOM_OUT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_ZOOM_OUT * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_ZOOM_OUT = 13, @@ -233,14 +261,16 @@ export declare enum IntentionCode { * INTENTION_ZOOM_IN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * INTENTION_ZOOM_IN * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ INTENTION_ZOOM_IN = 14 } diff --git a/api/@ohos.multimodalInput.keyCode.d.ts b/api/@ohos.multimodalInput.keyCode.d.ts index c555f3ff6b641919cced79f898ae36afb15c0d9b..25874dafe8e50e303bf2419a6a321194cff49272 100644 --- a/api/@ohos.multimodalInput.keyCode.d.ts +++ b/api/@ohos.multimodalInput.keyCode.d.ts @@ -31,14 +31,16 @@ * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum KeyCode { /** * KEYCODE_FN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FN = 0, @@ -46,7 +48,8 @@ export declare enum KeyCode { * KEYCODE_UNKNOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_UNKNOWN = -1, @@ -54,7 +57,8 @@ export declare enum KeyCode { * KEYCODE_HOME * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HOME = 1, @@ -62,7 +66,8 @@ export declare enum KeyCode { * KEYCODE_BACK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BACK = 2, @@ -70,7 +75,8 @@ export declare enum KeyCode { * KEYCODE_SEARCH * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 13 + * @since arkts {'1.1':'13', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SEARCH = 9, @@ -85,7 +91,8 @@ export declare enum KeyCode { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_PLAY_PAUSE = 10, @@ -100,7 +107,8 @@ export declare enum KeyCode { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_STOP = 11, @@ -115,7 +123,8 @@ export declare enum KeyCode { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_NEXT = 12, @@ -130,7 +139,8 @@ export declare enum KeyCode { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_PREVIOUS = 13, @@ -145,7 +155,8 @@ export declare enum KeyCode { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_REWIND = 14, @@ -160,7 +171,8 @@ export declare enum KeyCode { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_FAST_FORWARD = 15, @@ -168,7 +180,8 @@ export declare enum KeyCode { * KEYCODE_VOLUME_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VOLUME_UP = 16, @@ -176,7 +189,8 @@ export declare enum KeyCode { * KEYCODE_VOLUME_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VOLUME_DOWN = 17, @@ -184,7 +198,8 @@ export declare enum KeyCode { * KEYCODE_POWER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_POWER = 18, @@ -192,7 +207,8 @@ export declare enum KeyCode { * KEYCODE_CAMERA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CAMERA = 19, @@ -200,7 +216,8 @@ export declare enum KeyCode { * KEYCODE_VOLUME_MUTE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VOLUME_MUTE = 22, @@ -208,7 +225,8 @@ export declare enum KeyCode { * KEYCODE_MUTE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MUTE = 23, @@ -216,7 +234,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_UP = 40, @@ -224,7 +243,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_DOWN = 41, @@ -232,7 +252,8 @@ export declare enum KeyCode { * KEYCODE_0 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_0 = 2000, @@ -240,7 +261,8 @@ export declare enum KeyCode { * KEYCODE_1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_1 = 2001, @@ -248,7 +270,8 @@ export declare enum KeyCode { * KEYCODE_2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_2 = 2002, @@ -256,7 +279,8 @@ export declare enum KeyCode { * KEYCODE_3 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_3 = 2003, @@ -264,7 +288,8 @@ export declare enum KeyCode { * KEYCODE_4 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_4 = 2004, @@ -272,7 +297,8 @@ export declare enum KeyCode { * KEYCODE_5 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_5 = 2005, @@ -280,7 +306,8 @@ export declare enum KeyCode { * KEYCODE_6 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_6 = 2006, @@ -288,7 +315,8 @@ export declare enum KeyCode { * KEYCODE_7 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_7 = 2007, @@ -296,7 +324,8 @@ export declare enum KeyCode { * KEYCODE_8 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_8 = 2008, @@ -304,7 +333,8 @@ export declare enum KeyCode { * KEYCODE_9 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_9 = 2009, @@ -312,7 +342,8 @@ export declare enum KeyCode { * KEYCODE_STAR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_STAR = 2010, @@ -320,7 +351,8 @@ export declare enum KeyCode { * KEYCODE_POUND * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_POUND = 2011, @@ -328,7 +360,8 @@ export declare enum KeyCode { * KEYCODE_DPAD_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DPAD_UP = 2012, @@ -336,7 +369,8 @@ export declare enum KeyCode { * KEYCODE_DPAD_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DPAD_DOWN = 2013, @@ -344,7 +378,8 @@ export declare enum KeyCode { * KEYCODE_DPAD_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DPAD_LEFT = 2014, @@ -352,7 +387,8 @@ export declare enum KeyCode { * KEYCODE_DPAD_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DPAD_RIGHT = 2015, @@ -360,7 +396,8 @@ export declare enum KeyCode { * KEYCODE_DPAD_CENTER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DPAD_CENTER = 2016, @@ -368,7 +405,8 @@ export declare enum KeyCode { * KEYCODE_A * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_A = 2017, @@ -376,7 +414,8 @@ export declare enum KeyCode { * KEYCODE_B * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_B = 2018, @@ -384,7 +423,8 @@ export declare enum KeyCode { * KEYCODE_C * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_C = 2019, @@ -392,7 +432,8 @@ export declare enum KeyCode { * KEYCODE_D * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_D = 2020, @@ -400,7 +441,8 @@ export declare enum KeyCode { * KEYCODE_E * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_E = 2021, @@ -408,7 +450,8 @@ export declare enum KeyCode { * KEYCODE_F * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F = 2022, @@ -416,7 +459,8 @@ export declare enum KeyCode { * KEYCODE_G * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_G = 2023, @@ -424,7 +468,8 @@ export declare enum KeyCode { * KEYCODE_H * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_H = 2024, @@ -432,7 +477,8 @@ export declare enum KeyCode { * KEYCODE_I * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_I = 2025, @@ -440,7 +486,8 @@ export declare enum KeyCode { * KEYCODE_J * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_J = 2026, @@ -448,7 +495,8 @@ export declare enum KeyCode { * KEYCODE_K * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_K = 2027, @@ -456,7 +504,8 @@ export declare enum KeyCode { * KEYCODE_L * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_L = 2028, @@ -464,7 +513,8 @@ export declare enum KeyCode { * KEYCODE_M * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_M = 2029, @@ -472,7 +522,8 @@ export declare enum KeyCode { * KEYCODE_N * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_N = 2030, @@ -480,7 +531,8 @@ export declare enum KeyCode { * KEYCODE_O * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_O = 2031, @@ -488,7 +540,8 @@ export declare enum KeyCode { * KEYCODE_P * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_P = 2032, @@ -496,7 +549,8 @@ export declare enum KeyCode { * KEYCODE_Q * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_Q = 2033, @@ -504,7 +558,8 @@ export declare enum KeyCode { * KEYCODE_R * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_R = 2034, @@ -512,7 +567,8 @@ export declare enum KeyCode { * KEYCODE_S * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_S = 2035, @@ -520,7 +576,8 @@ export declare enum KeyCode { * KEYCODE_T * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_T = 2036, @@ -528,7 +585,8 @@ export declare enum KeyCode { * KEYCODE_U * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_U = 2037, @@ -536,7 +594,8 @@ export declare enum KeyCode { * KEYCODE_V * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_V = 2038, @@ -544,7 +603,8 @@ export declare enum KeyCode { * KEYCODE_W * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_W = 2039, @@ -552,7 +612,8 @@ export declare enum KeyCode { * KEYCODE_X * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_X = 2040, @@ -560,7 +621,8 @@ export declare enum KeyCode { * KEYCODE_Y * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_Y = 2041, @@ -568,7 +630,8 @@ export declare enum KeyCode { * KEYCODE_Z * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_Z = 2042, @@ -576,7 +639,8 @@ export declare enum KeyCode { * KEYCODE_COMMA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_COMMA = 2043, @@ -584,7 +648,8 @@ export declare enum KeyCode { * KEYCODE_PERIOD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PERIOD = 2044, @@ -592,7 +657,8 @@ export declare enum KeyCode { * KEYCODE_ALT_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ALT_LEFT = 2045, @@ -600,7 +666,8 @@ export declare enum KeyCode { * KEYCODE_ALT_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ALT_RIGHT = 2046, @@ -608,7 +675,8 @@ export declare enum KeyCode { * KEYCODE_SHIFT_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SHIFT_LEFT = 2047, @@ -616,7 +684,8 @@ export declare enum KeyCode { * KEYCODE_SHIFT_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SHIFT_RIGHT = 2048, @@ -624,7 +693,8 @@ export declare enum KeyCode { * KEYCODE_TAB * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_TAB = 2049, @@ -632,7 +702,8 @@ export declare enum KeyCode { * KEYCODE_SPACE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SPACE = 2050, @@ -640,7 +711,8 @@ export declare enum KeyCode { * KEYCODE_SYM * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SYM = 2051, @@ -648,7 +720,8 @@ export declare enum KeyCode { * KEYCODE_EXPLORER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_EXPLORER = 2052, @@ -656,7 +729,8 @@ export declare enum KeyCode { * KEYCODE_ENVELOPE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ENVELOPE = 2053, @@ -664,7 +738,8 @@ export declare enum KeyCode { * KEYCODE_ENTER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ENTER = 2054, @@ -672,7 +747,8 @@ export declare enum KeyCode { * KEYCODE_DEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DEL = 2055, @@ -680,7 +756,8 @@ export declare enum KeyCode { * KEYCODE_GRAVE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_GRAVE = 2056, @@ -688,7 +765,8 @@ export declare enum KeyCode { * KEYCODE_MINUS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MINUS = 2057, @@ -696,7 +774,8 @@ export declare enum KeyCode { * KEYCODE_EQUALS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_EQUALS = 2058, @@ -704,7 +783,8 @@ export declare enum KeyCode { * KEYCODE_LEFT_BRACKET * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_LEFT_BRACKET = 2059, @@ -712,7 +792,8 @@ export declare enum KeyCode { * KEYCODE_RIGHT_BRACKET * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_RIGHT_BRACKET = 2060, @@ -720,7 +801,8 @@ export declare enum KeyCode { * KEYCODE_BACKSLASH * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BACKSLASH = 2061, @@ -728,7 +810,8 @@ export declare enum KeyCode { * KEYCODE_SEMICOLON * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SEMICOLON = 2062, @@ -736,7 +819,8 @@ export declare enum KeyCode { * KEYCODE_APOSTROPHE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_APOSTROPHE = 2063, @@ -744,7 +828,8 @@ export declare enum KeyCode { * KEYCODE_SLASH * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SLASH = 2064, @@ -752,7 +837,8 @@ export declare enum KeyCode { * KEYCODE_AT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_AT = 2065, @@ -760,7 +846,8 @@ export declare enum KeyCode { * KEYCODE_PLUS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PLUS = 2066, @@ -768,7 +855,8 @@ export declare enum KeyCode { * KEYCODE_MENU * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MENU = 2067, @@ -776,7 +864,8 @@ export declare enum KeyCode { * KEYCODE_PAGE_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PAGE_UP = 2068, @@ -784,7 +873,8 @@ export declare enum KeyCode { * KEYCODE_PAGE_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PAGE_DOWN = 2069, @@ -792,7 +882,8 @@ export declare enum KeyCode { * KEYCODE_ESCAPE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ESCAPE = 2070, @@ -800,7 +891,8 @@ export declare enum KeyCode { * KEYCODE_FORWARD_DEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FORWARD_DEL = 2071, @@ -808,7 +900,8 @@ export declare enum KeyCode { * KEYCODE_CTRL_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CTRL_LEFT = 2072, @@ -816,7 +909,8 @@ export declare enum KeyCode { * KEYCODE_CTRL_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CTRL_RIGHT = 2073, @@ -824,7 +918,8 @@ export declare enum KeyCode { * KEYCODE_CAPS_LOCK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CAPS_LOCK = 2074, @@ -832,7 +927,8 @@ export declare enum KeyCode { * KEYCODE_SCROLL_LOCK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SCROLL_LOCK = 2075, @@ -840,7 +936,8 @@ export declare enum KeyCode { * KEYCODE_META_LEFT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_META_LEFT = 2076, @@ -848,7 +945,8 @@ export declare enum KeyCode { * KEYCODE_META_RIGHT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_META_RIGHT = 2077, @@ -856,7 +954,8 @@ export declare enum KeyCode { * KEYCODE_FUNCTION * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FUNCTION = 2078, @@ -864,7 +963,8 @@ export declare enum KeyCode { * KEYCODE_SYSRQ * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SYSRQ = 2079, @@ -872,7 +972,8 @@ export declare enum KeyCode { * KEYCODE_BREAK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BREAK = 2080, @@ -880,7 +981,8 @@ export declare enum KeyCode { * KEYCODE_MOVE_HOME * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MOVE_HOME = 2081, @@ -888,7 +990,8 @@ export declare enum KeyCode { * KEYCODE_MOVE_END * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MOVE_END = 2082, @@ -896,7 +999,8 @@ export declare enum KeyCode { * KEYCODE_INSERT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_INSERT = 2083, @@ -904,7 +1008,8 @@ export declare enum KeyCode { * KEYCODE_FORWARD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FORWARD = 2084, @@ -912,14 +1017,16 @@ export declare enum KeyCode { * KEYCODE_MEDIA_PLAY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * KEYCODE_MEDIA_PLAY * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_PLAY = 2085, @@ -927,14 +1034,16 @@ export declare enum KeyCode { * KEYCODE_MEDIA_PAUSE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * KEYCODE_MEDIA_PAUSE * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_PAUSE = 2086, @@ -942,7 +1051,8 @@ export declare enum KeyCode { * KEYCODE_MEDIA_CLOSE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_CLOSE = 2087, @@ -950,7 +1060,8 @@ export declare enum KeyCode { * KEYCODE_MEDIA_EJECT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_EJECT = 2088, @@ -958,7 +1069,8 @@ export declare enum KeyCode { * KEYCODE_MEDIA_RECORD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_RECORD = 2089, @@ -966,7 +1078,8 @@ export declare enum KeyCode { * KEYCODE_F1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F1 = 2090, @@ -974,7 +1087,8 @@ export declare enum KeyCode { * KEYCODE_F2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F2 = 2091, @@ -982,7 +1096,8 @@ export declare enum KeyCode { * KEYCODE_F3 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F3 = 2092, @@ -990,7 +1105,8 @@ export declare enum KeyCode { * KEYCODE_F4 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F4 = 2093, @@ -998,7 +1114,8 @@ export declare enum KeyCode { * KEYCODE_F5 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F5 = 2094, @@ -1006,7 +1123,8 @@ export declare enum KeyCode { * KEYCODE_F6 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F6 = 2095, @@ -1014,7 +1132,8 @@ export declare enum KeyCode { * KEYCODE_F7 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F7 = 2096, @@ -1022,7 +1141,8 @@ export declare enum KeyCode { * KEYCODE_F8 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F8 = 2097, @@ -1030,7 +1150,8 @@ export declare enum KeyCode { * KEYCODE_F9 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F9 = 2098, @@ -1038,7 +1159,8 @@ export declare enum KeyCode { * KEYCODE_F10 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F10 = 2099, @@ -1046,7 +1168,8 @@ export declare enum KeyCode { * KEYCODE_F11 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F11 = 2100, @@ -1054,7 +1177,8 @@ export declare enum KeyCode { * KEYCODE_F12 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F12 = 2101, @@ -1062,7 +1186,8 @@ export declare enum KeyCode { * KEYCODE_NUM_LOCK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUM_LOCK = 2102, @@ -1070,7 +1195,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_0 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_0 = 2103, @@ -1078,7 +1204,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_1 = 2104, @@ -1086,7 +1213,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_2 = 2105, @@ -1094,7 +1222,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_3 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_3 = 2106, @@ -1102,7 +1231,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_4 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_4 = 2107, @@ -1110,7 +1240,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_5 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_5 = 2108, @@ -1118,7 +1249,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_6 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_6 = 2109, @@ -1126,7 +1258,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_7 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_7 = 2110, @@ -1134,7 +1267,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_8 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_8 = 2111, @@ -1142,7 +1276,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_9 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_9 = 2112, @@ -1150,7 +1285,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_DIVIDE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_DIVIDE = 2113, @@ -1158,7 +1294,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_MULTIPLY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_MULTIPLY = 2114, @@ -1166,7 +1303,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_SUBTRACT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_SUBTRACT = 2115, @@ -1174,7 +1312,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_ADD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_ADD = 2116, @@ -1182,7 +1321,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_DOT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_DOT = 2117, @@ -1190,7 +1330,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_COMMA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_COMMA = 2118, @@ -1198,7 +1339,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_ENTER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_ENTER = 2119, @@ -1206,7 +1348,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_EQUALS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_EQUALS = 2120, @@ -1214,7 +1357,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_LEFT_PAREN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_LEFT_PAREN = 2121, @@ -1222,7 +1366,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_RIGHT_PAREN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_RIGHT_PAREN = 2122, @@ -1230,7 +1375,8 @@ export declare enum KeyCode { * KEYCODE_VIRTUAL_MULTITASK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VIRTUAL_MULTITASK = 2210, @@ -1238,7 +1384,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_A * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_A = 2301, @@ -1246,7 +1393,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_B * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_B = 2302, @@ -1254,7 +1402,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_X * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_X = 2304, @@ -1262,7 +1411,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_Y * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_Y = 2305, @@ -1270,7 +1420,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_L1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_L1 = 2307, @@ -1278,7 +1429,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_R1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_R1 = 2308, @@ -1286,7 +1438,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_L2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_L2 = 2309, @@ -1294,7 +1447,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_R2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_R2 = 2310, @@ -1302,7 +1456,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_SELECT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_SELECT = 2311, @@ -1310,7 +1465,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_START * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_START = 2312, @@ -1318,7 +1474,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_MODE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_MODE = 2313, @@ -1326,7 +1483,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_THUMBL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_THUMBL = 2314, @@ -1334,7 +1492,8 @@ export declare enum KeyCode { * KEYCODE_BUTTON_THUMBR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTON_THUMBR = 2315, @@ -1342,7 +1501,8 @@ export declare enum KeyCode { * KEYCODE_SLEEP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SLEEP = 2600, @@ -1350,7 +1510,8 @@ export declare enum KeyCode { * KEYCODE_ZENKAKU_HANKAKU * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ZENKAKU_HANKAKU = 2601, @@ -1358,7 +1519,8 @@ export declare enum KeyCode { * KEYCODE_102ND * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_102ND = 2602, @@ -1366,7 +1528,8 @@ export declare enum KeyCode { * KEYCODE_RO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_RO = 2603, @@ -1374,7 +1537,8 @@ export declare enum KeyCode { * KEYCODE_KATAKANA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KATAKANA = 2604, @@ -1382,7 +1546,8 @@ export declare enum KeyCode { * KEYCODE_HIRAGANA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HIRAGANA = 2605, @@ -1390,7 +1555,8 @@ export declare enum KeyCode { * KEYCODE_HENKAN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HENKAN = 2606, @@ -1398,7 +1564,8 @@ export declare enum KeyCode { * KEYCODE_KATAKANA_HIRAGANA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KATAKANA_HIRAGANA = 2607, @@ -1406,7 +1573,8 @@ export declare enum KeyCode { * KEYCODE_MUHENKAN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MUHENKAN = 2608, @@ -1414,7 +1582,8 @@ export declare enum KeyCode { * KEYCODE_LINEFEED * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_LINEFEED = 2609, @@ -1422,7 +1591,8 @@ export declare enum KeyCode { * KEYCODE_MACRO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MACRO = 2610, @@ -1430,7 +1600,8 @@ export declare enum KeyCode { * KEYCODE_NUMPAD_PLUSMINUS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NUMPAD_PLUSMINUS = 2611, @@ -1438,7 +1609,8 @@ export declare enum KeyCode { * KEYCODE_SCALE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SCALE = 2612, @@ -1446,7 +1618,8 @@ export declare enum KeyCode { * KEYCODE_HANGUEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HANGUEL = 2613, @@ -1454,7 +1627,8 @@ export declare enum KeyCode { * KEYCODE_HANJA * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HANJA = 2614, @@ -1462,7 +1636,8 @@ export declare enum KeyCode { * KEYCODE_YEN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_YEN = 2615, @@ -1470,7 +1645,8 @@ export declare enum KeyCode { * KEYCODE_STOP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_STOP = 2616, @@ -1478,7 +1654,8 @@ export declare enum KeyCode { * KEYCODE_AGAIN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_AGAIN = 2617, @@ -1486,7 +1663,8 @@ export declare enum KeyCode { * KEYCODE_PROPS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PROPS = 2618, @@ -1494,7 +1672,8 @@ export declare enum KeyCode { * KEYCODE_UNDO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_UNDO = 2619, @@ -1502,7 +1681,8 @@ export declare enum KeyCode { * KEYCODE_COPY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_COPY = 2620, @@ -1510,7 +1690,8 @@ export declare enum KeyCode { * KEYCODE_OPEN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_OPEN = 2621, @@ -1518,7 +1699,8 @@ export declare enum KeyCode { * KEYCODE_PASTE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PASTE = 2622, @@ -1526,7 +1708,8 @@ export declare enum KeyCode { * KEYCODE_FIND * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FIND = 2623, @@ -1534,7 +1717,8 @@ export declare enum KeyCode { * KEYCODE_CUT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CUT = 2624, @@ -1542,7 +1726,8 @@ export declare enum KeyCode { * KEYCODE_HELP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HELP = 2625, @@ -1550,7 +1735,8 @@ export declare enum KeyCode { * KEYCODE_CALC * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CALC = 2626, @@ -1558,7 +1744,8 @@ export declare enum KeyCode { * KEYCODE_FILE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FILE = 2627, @@ -1566,7 +1753,8 @@ export declare enum KeyCode { * KEYCODE_BOOKMARKS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BOOKMARKS = 2628, @@ -1574,7 +1762,8 @@ export declare enum KeyCode { * KEYCODE_NEXT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NEXT = 2629, @@ -1582,7 +1771,8 @@ export declare enum KeyCode { * KEYCODE_PLAYPAUSE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PLAYPAUSE = 2630, @@ -1590,7 +1780,8 @@ export declare enum KeyCode { * KEYCODE_PREVIOUS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PREVIOUS = 2631, @@ -1598,7 +1789,8 @@ export declare enum KeyCode { * KEYCODE_STOPCD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_STOPCD = 2632, @@ -1606,7 +1798,8 @@ export declare enum KeyCode { * KEYCODE_CONFIG * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CONFIG = 2634, @@ -1614,7 +1807,8 @@ export declare enum KeyCode { * KEYCODE_REFRESH * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_REFRESH = 2635, @@ -1622,7 +1816,8 @@ export declare enum KeyCode { * KEYCODE_EXIT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_EXIT = 2636, @@ -1630,7 +1825,8 @@ export declare enum KeyCode { * KEYCODE_EDIT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_EDIT = 2637, @@ -1638,7 +1834,8 @@ export declare enum KeyCode { * KEYCODE_SCROLLUP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SCROLLUP = 2638, @@ -1646,7 +1843,8 @@ export declare enum KeyCode { * KEYCODE_SCROLLDOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SCROLLDOWN = 2639, @@ -1654,7 +1852,8 @@ export declare enum KeyCode { * KEYCODE_NEW * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NEW = 2640, @@ -1662,7 +1861,8 @@ export declare enum KeyCode { * KEYCODE_REDO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_REDO = 2641, @@ -1670,7 +1870,8 @@ export declare enum KeyCode { * KEYCODE_CLOSE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CLOSE = 2642, @@ -1678,7 +1879,8 @@ export declare enum KeyCode { * KEYCODE_PLAY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PLAY = 2643, @@ -1686,7 +1888,8 @@ export declare enum KeyCode { * KEYCODE_BASSBOOST * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BASSBOOST = 2644, @@ -1694,7 +1897,8 @@ export declare enum KeyCode { * KEYCODE_PRINT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PRINT = 2645, @@ -1702,7 +1906,8 @@ export declare enum KeyCode { * KEYCODE_CHAT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CHAT = 2646, @@ -1710,7 +1915,8 @@ export declare enum KeyCode { * KEYCODE_FINANCE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FINANCE = 2647, @@ -1718,7 +1924,8 @@ export declare enum KeyCode { * KEYCODE_CANCEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CANCEL = 2648, @@ -1726,7 +1933,8 @@ export declare enum KeyCode { * KEYCODE_KBDILLUM_TOGGLE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDILLUM_TOGGLE = 2649, @@ -1734,7 +1942,8 @@ export declare enum KeyCode { * KEYCODE_KBDILLUM_DOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDILLUM_DOWN = 2650, @@ -1742,7 +1951,8 @@ export declare enum KeyCode { * KEYCODE_KBDILLUM_UP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDILLUM_UP = 2651, @@ -1750,7 +1960,8 @@ export declare enum KeyCode { * KEYCODE_SEND * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SEND = 2652, @@ -1758,7 +1969,8 @@ export declare enum KeyCode { * KEYCODE_REPLY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_REPLY = 2653, @@ -1766,7 +1978,8 @@ export declare enum KeyCode { * KEYCODE_FORWARDMAIL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FORWARDMAIL = 2654, @@ -1774,7 +1987,8 @@ export declare enum KeyCode { * KEYCODE_SAVE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SAVE = 2655, @@ -1782,7 +1996,8 @@ export declare enum KeyCode { * KEYCODE_DOCUMENTS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DOCUMENTS = 2656, @@ -1790,7 +2005,8 @@ export declare enum KeyCode { * KEYCODE_VIDEO_NEXT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VIDEO_NEXT = 2657, @@ -1798,7 +2014,8 @@ export declare enum KeyCode { * KEYCODE_VIDEO_PREV * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VIDEO_PREV = 2658, @@ -1806,7 +2023,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_CYCLE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_CYCLE = 2659, @@ -1814,7 +2032,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_ZERO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_ZERO = 2660, @@ -1822,7 +2041,8 @@ export declare enum KeyCode { * KEYCODE_DISPLAY_OFF * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DISPLAY_OFF = 2661, @@ -1830,7 +2050,8 @@ export declare enum KeyCode { * KEYCODE_BTN_MISC * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_MISC = 2662, @@ -1838,7 +2059,8 @@ export declare enum KeyCode { * KEYCODE_GOTO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_GOTO = 2663, @@ -1846,7 +2068,8 @@ export declare enum KeyCode { * KEYCODE_INFO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_INFO = 2664, @@ -1854,7 +2077,8 @@ export declare enum KeyCode { * KEYCODE_PROGRAM * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PROGRAM = 2665, @@ -1862,7 +2086,8 @@ export declare enum KeyCode { * KEYCODE_PVR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PVR = 2666, @@ -1870,7 +2095,8 @@ export declare enum KeyCode { * KEYCODE_SUBTITLE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SUBTITLE = 2667, @@ -1878,7 +2104,8 @@ export declare enum KeyCode { * KEYCODE_FULL_SCREEN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FULL_SCREEN = 2668, @@ -1886,7 +2113,8 @@ export declare enum KeyCode { * KEYCODE_KEYBOARD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KEYBOARD = 2669, @@ -1894,7 +2122,8 @@ export declare enum KeyCode { * KEYCODE_ASPECT_RATIO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ASPECT_RATIO = 2670, @@ -1902,7 +2131,8 @@ export declare enum KeyCode { * KEYCODE_PC * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PC = 2671, @@ -1910,7 +2140,8 @@ export declare enum KeyCode { * KEYCODE_TV * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_TV = 2672, @@ -1918,7 +2149,8 @@ export declare enum KeyCode { * KEYCODE_TV2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_TV2 = 2673, @@ -1926,7 +2158,8 @@ export declare enum KeyCode { * KEYCODE_VCR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VCR = 2674, @@ -1934,7 +2167,8 @@ export declare enum KeyCode { * KEYCODE_VCR2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VCR2 = 2675, @@ -1942,7 +2176,8 @@ export declare enum KeyCode { * KEYCODE_SAT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SAT = 2676, @@ -1950,7 +2185,8 @@ export declare enum KeyCode { * KEYCODE_CD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CD = 2677, @@ -1958,7 +2194,8 @@ export declare enum KeyCode { * KEYCODE_TAPE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_TAPE = 2678, @@ -1966,7 +2203,8 @@ export declare enum KeyCode { * KEYCODE_TUNER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_TUNER = 2679, @@ -1974,7 +2212,8 @@ export declare enum KeyCode { * KEYCODE_PLAYER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PLAYER = 2680, @@ -1982,7 +2221,8 @@ export declare enum KeyCode { * KEYCODE_DVD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DVD = 2681, @@ -1990,7 +2230,8 @@ export declare enum KeyCode { * KEYCODE_AUDIO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_AUDIO = 2682, @@ -1998,7 +2239,8 @@ export declare enum KeyCode { * KEYCODE_VIDEO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VIDEO = 2683, @@ -2006,7 +2248,8 @@ export declare enum KeyCode { * KEYCODE_MEMO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEMO = 2684, @@ -2014,7 +2257,8 @@ export declare enum KeyCode { * KEYCODE_CALENDAR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CALENDAR = 2685, @@ -2022,7 +2266,8 @@ export declare enum KeyCode { * KEYCODE_RED * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_RED = 2686, @@ -2030,7 +2275,8 @@ export declare enum KeyCode { * KEYCODE_GREEN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_GREEN = 2687, @@ -2038,7 +2284,8 @@ export declare enum KeyCode { * KEYCODE_YELLOW * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_YELLOW = 2688, @@ -2046,7 +2293,8 @@ export declare enum KeyCode { * KEYCODE_BLUE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BLUE = 2689, @@ -2054,7 +2302,8 @@ export declare enum KeyCode { * KEYCODE_CHANNELUP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CHANNELUP = 2690, @@ -2062,7 +2311,8 @@ export declare enum KeyCode { * KEYCODE_CHANNELDOWN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CHANNELDOWN = 2691, @@ -2070,7 +2320,8 @@ export declare enum KeyCode { * KEYCODE_LAST * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_LAST = 2692, @@ -2078,7 +2329,8 @@ export declare enum KeyCode { * KEYCODE_RESTART * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_RESTART = 2693, @@ -2086,7 +2338,8 @@ export declare enum KeyCode { * KEYCODE_SLOW * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SLOW = 2694, @@ -2094,7 +2347,8 @@ export declare enum KeyCode { * KEYCODE_SHUFFLE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SHUFFLE = 2695, @@ -2102,7 +2356,8 @@ export declare enum KeyCode { * KEYCODE_VIDEOPHONE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VIDEOPHONE = 2696, @@ -2110,7 +2365,8 @@ export declare enum KeyCode { * KEYCODE_GAMES * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_GAMES = 2697, @@ -2118,7 +2374,8 @@ export declare enum KeyCode { * KEYCODE_ZOOMIN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ZOOMIN = 2698, @@ -2126,7 +2383,8 @@ export declare enum KeyCode { * KEYCODE_ZOOMOUT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ZOOMOUT = 2699, @@ -2134,7 +2392,8 @@ export declare enum KeyCode { * KEYCODE_ZOOMRESET * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ZOOMRESET = 2700, @@ -2142,7 +2401,8 @@ export declare enum KeyCode { * KEYCODE_WORDPROCESSOR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_WORDPROCESSOR = 2701, @@ -2150,7 +2410,8 @@ export declare enum KeyCode { * KEYCODE_EDITOR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_EDITOR = 2702, @@ -2158,7 +2419,8 @@ export declare enum KeyCode { * KEYCODE_SPREADSHEET * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SPREADSHEET = 2703, @@ -2166,7 +2428,8 @@ export declare enum KeyCode { * KEYCODE_GRAPHICSEDITOR * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_GRAPHICSEDITOR = 2704, @@ -2174,7 +2437,8 @@ export declare enum KeyCode { * KEYCODE_PRESENTATION * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PRESENTATION = 2705, @@ -2182,7 +2446,8 @@ export declare enum KeyCode { * KEYCODE_DATABASE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DATABASE = 2706, @@ -2190,7 +2455,8 @@ export declare enum KeyCode { * KEYCODE_NEWS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_NEWS = 2707, @@ -2198,7 +2464,8 @@ export declare enum KeyCode { * KEYCODE_VOICEMAIL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_VOICEMAIL = 2708, @@ -2206,7 +2473,8 @@ export declare enum KeyCode { * KEYCODE_ADDRESSBOOK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ADDRESSBOOK = 2709, @@ -2214,7 +2482,8 @@ export declare enum KeyCode { * KEYCODE_MESSENGER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MESSENGER = 2710, @@ -2222,7 +2491,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_TOGGLE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_TOGGLE = 2711, @@ -2230,7 +2500,8 @@ export declare enum KeyCode { * KEYCODE_SPELLCHECK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SPELLCHECK = 2712, @@ -2238,7 +2509,8 @@ export declare enum KeyCode { * KEYCODE_COFFEE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_COFFEE = 2713, @@ -2246,7 +2518,8 @@ export declare enum KeyCode { * KEYCODE_MEDIA_REPEAT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MEDIA_REPEAT = 2714, @@ -2254,7 +2527,8 @@ export declare enum KeyCode { * KEYCODE_IMAGES * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_IMAGES = 2715, @@ -2262,7 +2536,8 @@ export declare enum KeyCode { * KEYCODE_BUTTONCONFIG * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BUTTONCONFIG = 2716, @@ -2270,7 +2545,8 @@ export declare enum KeyCode { * KEYCODE_TASKMANAGER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_TASKMANAGER = 2717, @@ -2278,7 +2554,8 @@ export declare enum KeyCode { * KEYCODE_JOURNAL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_JOURNAL = 2718, @@ -2286,7 +2563,8 @@ export declare enum KeyCode { * KEYCODE_CONTROLPANEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CONTROLPANEL = 2719, @@ -2294,7 +2572,8 @@ export declare enum KeyCode { * KEYCODE_APPSELECT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_APPSELECT = 2720, @@ -2302,7 +2581,8 @@ export declare enum KeyCode { * KEYCODE_SCREENSAVER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SCREENSAVER = 2721, @@ -2310,7 +2590,8 @@ export declare enum KeyCode { * KEYCODE_ASSISTANT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ASSISTANT = 2722, @@ -2318,7 +2599,8 @@ export declare enum KeyCode { * KEYCODE_KBD_LAYOUT_NEXT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBD_LAYOUT_NEXT = 2723, @@ -2326,7 +2608,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_MIN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_MIN = 2724, @@ -2334,7 +2617,8 @@ export declare enum KeyCode { * KEYCODE_BRIGHTNESS_MAX * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BRIGHTNESS_MAX = 2725, @@ -2342,7 +2626,8 @@ export declare enum KeyCode { * KEYCODE_KBDINPUTASSIST_PREV * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDINPUTASSIST_PREV = 2726, @@ -2350,7 +2635,8 @@ export declare enum KeyCode { * KEYCODE_KBDINPUTASSIST_NEXT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDINPUTASSIST_NEXT = 2727, @@ -2358,7 +2644,8 @@ export declare enum KeyCode { * KEYCODE_KBDINPUTASSIST_PREVGROUP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDINPUTASSIST_PREVGROUP = 2728, @@ -2366,7 +2653,8 @@ export declare enum KeyCode { * KEYCODE_KBDINPUTASSIST_NEXTGROUP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDINPUTASSIST_NEXTGROUP = 2729, @@ -2374,7 +2662,8 @@ export declare enum KeyCode { * KEYCODE_KBDINPUTASSIST_ACCEPT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDINPUTASSIST_ACCEPT = 2730, @@ -2382,7 +2671,8 @@ export declare enum KeyCode { * KEYCODE_KBDINPUTASSIST_CANCEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_KBDINPUTASSIST_CANCEL = 2731, @@ -2390,7 +2680,8 @@ export declare enum KeyCode { * KEYCODE_FRONT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_FRONT = 2800, @@ -2398,7 +2689,8 @@ export declare enum KeyCode { * KEYCODE_SETUP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SETUP = 2801, @@ -2406,7 +2698,8 @@ export declare enum KeyCode { * KEYCODE_WAKEUP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_WAKEUP = 2802, @@ -2414,7 +2707,8 @@ export declare enum KeyCode { * KEYCODE_SENDFILE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SENDFILE = 2803, @@ -2422,7 +2716,8 @@ export declare enum KeyCode { * KEYCODE_DELETEFILE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DELETEFILE = 2804, @@ -2430,7 +2725,8 @@ export declare enum KeyCode { * KEYCODE_XFER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_XFER = 2805, @@ -2438,7 +2734,8 @@ export declare enum KeyCode { * KEYCODE_PROG1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PROG1 = 2806, @@ -2446,7 +2743,8 @@ export declare enum KeyCode { * KEYCODE_PROG2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PROG2 = 2807, @@ -2454,7 +2752,8 @@ export declare enum KeyCode { * KEYCODE_MSDOS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MSDOS = 2808, @@ -2462,7 +2761,8 @@ export declare enum KeyCode { * KEYCODE_SCREENLOCK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SCREENLOCK = 2809, @@ -2470,7 +2770,8 @@ export declare enum KeyCode { * KEYCODE_DIRECTION_ROTATE_DISPLAY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DIRECTION_ROTATE_DISPLAY = 2810, @@ -2478,7 +2779,8 @@ export declare enum KeyCode { * KEYCODE_CYCLEWINDOWS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CYCLEWINDOWS = 2811, @@ -2486,7 +2788,8 @@ export declare enum KeyCode { * KEYCODE_COMPUTER * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_COMPUTER = 2812, @@ -2494,7 +2797,8 @@ export declare enum KeyCode { * KEYCODE_EJECTCLOSECD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_EJECTCLOSECD = 2813, @@ -2502,7 +2806,8 @@ export declare enum KeyCode { * KEYCODE_ISO * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ISO = 2814, @@ -2510,7 +2815,8 @@ export declare enum KeyCode { * KEYCODE_MOVE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_MOVE = 2815, @@ -2518,7 +2824,8 @@ export declare enum KeyCode { * KEYCODE_F13 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F13 = 2816, @@ -2526,7 +2833,8 @@ export declare enum KeyCode { * KEYCODE_F14 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F14 = 2817, @@ -2534,7 +2842,8 @@ export declare enum KeyCode { * KEYCODE_F15 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F15 = 2818, @@ -2542,7 +2851,8 @@ export declare enum KeyCode { * KEYCODE_F16 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F16 = 2819, @@ -2550,7 +2860,8 @@ export declare enum KeyCode { * KEYCODE_F17 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F17 = 2820, @@ -2558,7 +2869,8 @@ export declare enum KeyCode { * KEYCODE_F18 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F18 = 2821, @@ -2566,7 +2878,8 @@ export declare enum KeyCode { * KEYCODE_F19 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F19 = 2822, @@ -2574,7 +2887,8 @@ export declare enum KeyCode { * KEYCODE_F20 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F20 = 2823, @@ -2582,7 +2896,8 @@ export declare enum KeyCode { * KEYCODE_F21 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F21 = 2824, @@ -2590,7 +2905,8 @@ export declare enum KeyCode { * KEYCODE_F22 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F22 = 2825, @@ -2598,7 +2914,8 @@ export declare enum KeyCode { * KEYCODE_F23 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F23 = 2826, @@ -2606,7 +2923,8 @@ export declare enum KeyCode { * KEYCODE_F24 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_F24 = 2827, @@ -2614,7 +2932,8 @@ export declare enum KeyCode { * KEYCODE_PROG3 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PROG3 = 2828, @@ -2622,7 +2941,8 @@ export declare enum KeyCode { * KEYCODE_PROG4 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_PROG4 = 2829, @@ -2630,7 +2950,8 @@ export declare enum KeyCode { * KEYCODE_DASHBOARD * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DASHBOARD = 2830, @@ -2638,7 +2959,8 @@ export declare enum KeyCode { * KEYCODE_SUSPEND * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SUSPEND = 2831, @@ -2646,7 +2968,8 @@ export declare enum KeyCode { * KEYCODE_HP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_HP = 2832, @@ -2654,7 +2977,8 @@ export declare enum KeyCode { * KEYCODE_SOUND * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SOUND = 2833, @@ -2662,7 +2986,8 @@ export declare enum KeyCode { * KEYCODE_QUESTION * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_QUESTION = 2834, @@ -2670,7 +2995,8 @@ export declare enum KeyCode { * KEYCODE_CONNECT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CONNECT = 2836, @@ -2678,7 +3004,8 @@ export declare enum KeyCode { * KEYCODE_SPORT * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SPORT = 2837, @@ -2686,7 +3013,8 @@ export declare enum KeyCode { * KEYCODE_SHOP * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SHOP = 2838, @@ -2694,7 +3022,8 @@ export declare enum KeyCode { * KEYCODE_ALTERASE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_ALTERASE = 2839, @@ -2702,7 +3031,8 @@ export declare enum KeyCode { * KEYCODE_SWITCHVIDEOMODE * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_SWITCHVIDEOMODE = 2841, @@ -2710,7 +3040,8 @@ export declare enum KeyCode { * KEYCODE_BATTERY * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BATTERY = 2842, @@ -2718,7 +3049,8 @@ export declare enum KeyCode { * KEYCODE_BLUETOOTH * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BLUETOOTH = 2843, @@ -2726,7 +3058,8 @@ export declare enum KeyCode { * KEYCODE_WLAN * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_WLAN = 2844, @@ -2734,7 +3067,8 @@ export declare enum KeyCode { * KEYCODE_UWB * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_UWB = 2845, @@ -2742,7 +3076,8 @@ export declare enum KeyCode { * KEYCODE_WWAN_WIMAX * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_WWAN_WIMAX = 2846, @@ -2750,7 +3085,8 @@ export declare enum KeyCode { * KEYCODE_RFKILL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_RFKILL = 2847, @@ -2758,7 +3094,8 @@ export declare enum KeyCode { * KEYCODE_CHANNEL * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_CHANNEL = 3001, @@ -2766,7 +3103,8 @@ export declare enum KeyCode { * KEYCODE_BTN_0 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_0 = 3100, @@ -2774,7 +3112,8 @@ export declare enum KeyCode { * KEYCODE_BTN_1 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_1 = 3101, @@ -2782,7 +3121,8 @@ export declare enum KeyCode { * KEYCODE_BTN_2 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_2 = 3102, @@ -2790,7 +3130,8 @@ export declare enum KeyCode { * KEYCODE_BTN_3 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_3 = 3103, @@ -2798,7 +3139,8 @@ export declare enum KeyCode { * KEYCODE_BTN_4 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_4 = 3104, @@ -2806,7 +3148,8 @@ export declare enum KeyCode { * KEYCODE_BTN_5 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_5 = 3105, @@ -2814,7 +3157,8 @@ export declare enum KeyCode { * KEYCODE_BTN_6 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_6 = 3106, @@ -2822,7 +3166,8 @@ export declare enum KeyCode { * KEYCODE_BTN_7 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_7 = 3107, @@ -2830,7 +3175,8 @@ export declare enum KeyCode { * KEYCODE_BTN_8 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_8 = 3108, @@ -2838,7 +3184,8 @@ export declare enum KeyCode { * KEYCODE_BTN_9 * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_BTN_9 = 3109, @@ -2846,7 +3193,8 @@ export declare enum KeyCode { * KEYCODE_DAGGER_CLICK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DAGGER_CLICK = 3211, @@ -2854,7 +3202,8 @@ export declare enum KeyCode { * KEYCODE_DAGGER_DOUBLE_CLICK * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DAGGER_DOUBLE_CLICK = 3212, @@ -2862,7 +3211,8 @@ export declare enum KeyCode { * KEYCODE_DAGGER_LONG_PRESS * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ KEYCODE_DAGGER_LONG_PRESS = 3213 } diff --git a/api/@ohos.multimodalInput.keyEvent.d.ts b/api/@ohos.multimodalInput.keyEvent.d.ts index da04f64ae460f9d794b0d1e18c970f16b89829ba..6d192e104f23f73be53e083b05d595b75cedf39a 100644 --- a/api/@ohos.multimodalInput.keyEvent.d.ts +++ b/api/@ohos.multimodalInput.keyEvent.d.ts @@ -18,8 +18,9 @@ * @kit InputKit */ -import type { InputEvent } from './@ohos.multimodalInput.inputEvent'; +import { InputEvent } from './@ohos.multimodalInput.inputEvent'; import type { KeyCode } from './@ohos.multimodalInput.keyCode'; + /** * Action * @@ -33,7 +34,8 @@ import type { KeyCode } from './@ohos.multimodalInput.keyCode'; * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum Action { /** @@ -47,7 +49,8 @@ export declare enum Action { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 0, @@ -62,7 +65,8 @@ export declare enum Action { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ DOWN = 1, @@ -77,7 +81,8 @@ export declare enum Action { * * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UP = 2 } @@ -95,7 +100,8 @@ export declare enum Action { * @typedef Key * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface Key { /** @@ -109,7 +115,8 @@ export declare interface Key { * @type { KeyCode } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ code: KeyCode; @@ -121,12 +128,13 @@ export declare interface Key { */ /** * Time when the key is pressed - * @type { number } + * @type { long } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - pressedTime: number; + pressedTime: long; /** * Device to which the key belongs @@ -136,12 +144,13 @@ export declare interface Key { */ /** * Device to which the key belongs - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - deviceId: number; + deviceId: int; } /** @@ -158,7 +167,8 @@ export declare interface Key { * @extends InputEvent * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface KeyEvent extends InputEvent { /** @@ -172,7 +182,8 @@ export declare interface KeyEvent extends InputEvent { * @type { Action } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ action: Action; @@ -187,7 +198,8 @@ export declare interface KeyEvent extends InputEvent { * @type { Key } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ key: Key; @@ -199,12 +211,13 @@ export declare interface KeyEvent extends InputEvent { */ /** * Unicode character corresponding to the key - * @type { number } + * @type { int } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - unicodeChar: number; + unicodeChar: int; /** * List of pressed keys @@ -217,7 +230,8 @@ export declare interface KeyEvent extends InputEvent { * @type { Key[] } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ keys: Key[]; @@ -232,7 +246,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ ctrlKey: boolean; @@ -247,7 +262,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ altKey: boolean; @@ -262,7 +278,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ shiftKey: boolean; @@ -277,7 +294,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ logoKey: boolean; @@ -292,7 +310,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ fnKey: boolean; @@ -307,7 +326,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ capsLock: boolean; @@ -322,7 +342,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ numLock: boolean; @@ -337,7 +358,8 @@ export declare interface KeyEvent extends InputEvent { * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollLock: boolean; } \ No newline at end of file diff --git a/api/@ohos.multimodalInput.mouseEvent.d.ts b/api/@ohos.multimodalInput.mouseEvent.d.ts index 29c7d1936b505ea2a22aa3ee714a09856013d292..f1728d31420b37698c29738475107e12003fac5e 100644 --- a/api/@ohos.multimodalInput.mouseEvent.d.ts +++ b/api/@ohos.multimodalInput.mouseEvent.d.ts @@ -18,22 +18,29 @@ * @kit InputKit */ +/*** if arkts 1.1 */ import type { InputEvent } from './@ohos.multimodalInput.inputEvent'; import type { KeyCode } from './@ohos.multimodalInput.keyCode'; +/*** endif */ +/*** if arkts 1.2 */ +import { InputEvent } from './@ohos.multimodalInput.inputEvent'; +/*** endif */ /** * Action * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum Action { /** * Cancel * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 0, @@ -41,7 +48,8 @@ export declare enum Action { * Moving of the mouse pointer * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MOVE = 1, @@ -49,7 +57,8 @@ export declare enum Action { * Pressing down of the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ BUTTON_DOWN = 2, @@ -57,7 +66,8 @@ export declare enum Action { * Lifting of the mouse button * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ BUTTON_UP = 3, @@ -65,7 +75,8 @@ export declare enum Action { * Beginning of the axis event associated with the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ AXIS_BEGIN = 4, @@ -73,7 +84,8 @@ export declare enum Action { * Updating of the axis event associated with the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ AXIS_UPDATE = 5, @@ -81,7 +93,8 @@ export declare enum Action { * Ending of the axis event associated with the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ AXIS_END = 6, @@ -89,7 +102,8 @@ export declare enum Action { * Indicates a pointer action representing that a finger is pressed on touchpad. * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_DOWN = 7, @@ -97,7 +111,8 @@ export declare enum Action { * Indicates a pointer action representing that a finger leaves touchpad. * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTION_UP = 8, } @@ -107,14 +122,16 @@ export declare enum Action { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum Button { /** * Left button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LEFT = 0, @@ -122,7 +139,8 @@ export declare enum Button { * Middle button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE = 1, @@ -130,7 +148,8 @@ export declare enum Button { * Right button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT = 2, @@ -138,7 +157,8 @@ export declare enum Button { * Side button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SIDE = 3, @@ -146,7 +166,8 @@ export declare enum Button { * Extended button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ EXTRA = 4, @@ -154,7 +175,8 @@ export declare enum Button { * Forward button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ FORWARD = 5, @@ -162,7 +184,8 @@ export declare enum Button { * Back button on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ BACK = 6, @@ -170,7 +193,8 @@ export declare enum Button { * Task key on the mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TASK = 7 } @@ -180,14 +204,16 @@ export declare enum Button { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum Axis { /** * Vertical scroll axis * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_VERTICAL = 0, @@ -195,7 +221,8 @@ export declare enum Axis { * Horizontal scroll axis * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SCROLL_HORIZONTAL = 1, @@ -203,7 +230,8 @@ export declare enum Axis { * Pinch axis * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PINCH = 2 } @@ -213,14 +241,16 @@ export declare enum Axis { * * @interface AxisValue * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface AxisValue { /** * Axis type * @type { Axis } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ axis: Axis; @@ -228,7 +258,8 @@ export declare interface AxisValue { * Axis value * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ value: number; } @@ -238,14 +269,16 @@ export declare interface AxisValue { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum ToolType { /** * Unknown type * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN = 0, @@ -253,7 +286,8 @@ export declare enum ToolType { * Mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ MOUSE = 1, @@ -261,7 +295,8 @@ export declare enum ToolType { * Joystick * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ JOYSTICK = 2, @@ -269,7 +304,8 @@ export declare enum ToolType { * Touch pad * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCHPAD = 3, } @@ -280,14 +316,16 @@ export declare enum ToolType { * @extends InputEvent * @interface MouseEvent * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface MouseEvent extends InputEvent { /** * Mouse event action * @type { Action } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ action: Action; @@ -295,7 +333,8 @@ export declare interface MouseEvent extends InputEvent { * X coordinate of the mouse pointer on the screen * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ screenX: number; @@ -303,7 +342,8 @@ export declare interface MouseEvent extends InputEvent { * Y coordinate of the mouse pointer on the screen * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ screenY: number; @@ -311,7 +351,8 @@ export declare interface MouseEvent extends InputEvent { * X coordinate of the mouse pointer in the window * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -319,7 +360,8 @@ export declare interface MouseEvent extends InputEvent { * Y coordinate of the mouse pointer in the window * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -328,7 +370,8 @@ export declare interface MouseEvent extends InputEvent { * the edge of the screen, the value may be less than the difference of the X coordinate reported twice. * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rawDeltaX: number; @@ -336,7 +379,8 @@ export declare interface MouseEvent extends InputEvent { * Y axis offset relative to the previous reported mouse pointer position * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rawDeltaY: number; @@ -344,7 +388,8 @@ export declare interface MouseEvent extends InputEvent { * Button that is currently pressed or released * @type { Button } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ button: Button; @@ -352,7 +397,8 @@ export declare interface MouseEvent extends InputEvent { * Button that is being pressed * @type { Button[] } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ pressedButtons: Button[]; @@ -360,7 +406,8 @@ export declare interface MouseEvent extends InputEvent { * All axis data contained in the event * @type { AxisValue[] } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ axes: AxisValue[]; @@ -376,7 +423,8 @@ export declare interface MouseEvent extends InputEvent { * Whether ctrlKey is being pressed * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ctrlKey: boolean; @@ -384,7 +432,8 @@ export declare interface MouseEvent extends InputEvent { * Whether altKey is being pressed * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ altKey: boolean; @@ -392,7 +441,8 @@ export declare interface MouseEvent extends InputEvent { * Whether shiftKey is being pressed * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ shiftKey: boolean; @@ -400,7 +450,8 @@ export declare interface MouseEvent extends InputEvent { * Whether logoKey is being pressed * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ logoKey: boolean; @@ -408,7 +459,8 @@ export declare interface MouseEvent extends InputEvent { * Whether fnKey is being pressed * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ fnKey: boolean; @@ -416,7 +468,8 @@ export declare interface MouseEvent extends InputEvent { * Whether capsLock is active * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ capsLock: boolean; @@ -424,7 +477,8 @@ export declare interface MouseEvent extends InputEvent { * Whether numLock is active * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ numLock: boolean; @@ -432,7 +486,8 @@ export declare interface MouseEvent extends InputEvent { * Whether scrollLock is active * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ scrollLock: boolean; @@ -441,7 +496,8 @@ export declare interface MouseEvent extends InputEvent { * * @type { ToolType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ toolType: ToolType; } \ No newline at end of file diff --git a/api/@ohos.multimodalInput.pointer.d.ts b/api/@ohos.multimodalInput.pointer.d.ts index 5d289d172a90e0c0f6f858095c3777ed9fbbe51c..7d08347a068d8ac2fe661ee12a1fbb4744d674f2 100644 --- a/api/@ohos.multimodalInput.pointer.d.ts +++ b/api/@ohos.multimodalInput.pointer.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2022-2023 Huawei Device Co., Ltd. + * Copyright (c) 2022-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 @@ -18,8 +18,14 @@ * @kit InputKit */ +/*** if arkts 1.1 */ import type { AsyncCallback } from './@ohos.base'; import type image from './@ohos.multimedia.image'; +/*** endif */ +/*** if arkts 1.2 */ +import { AsyncCallback } from './@ohos.base'; +import image from './@ohos.multimedia.image'; +/*** endif */ /** * Declares interfaces related to mouse pointer attributes. @@ -34,7 +40,8 @@ import type image from './@ohos.multimedia.image'; * @namespace pointer * @syscap SystemCapability.MultimodalInput.Input.Pointer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace pointer { /** @@ -50,14 +57,17 @@ declare namespace pointer { * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Pointer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 + */ enum PointerStyle { /** * Default * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT, @@ -65,7 +75,8 @@ declare namespace pointer { * East arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ EAST, @@ -73,7 +84,8 @@ declare namespace pointer { * West arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ WEST, @@ -81,7 +93,8 @@ declare namespace pointer { * South arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SOUTH, @@ -89,7 +102,8 @@ declare namespace pointer { * North arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NORTH, @@ -97,7 +111,8 @@ declare namespace pointer { * East-west arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ WEST_EAST, @@ -105,7 +120,8 @@ declare namespace pointer { * North-south arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NORTH_SOUTH, @@ -113,7 +129,8 @@ declare namespace pointer { * North-east arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NORTH_EAST, @@ -121,7 +138,8 @@ declare namespace pointer { * North-west arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NORTH_WEST, @@ -129,7 +147,8 @@ declare namespace pointer { * South-east arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SOUTH_EAST, @@ -137,7 +156,8 @@ declare namespace pointer { * South-west arrow * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SOUTH_WEST, @@ -145,7 +165,8 @@ declare namespace pointer { * Northeast and southwest adjustment * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NORTH_EAST_SOUTH_WEST, @@ -153,7 +174,8 @@ declare namespace pointer { * Northwest and southeast adjustment * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ NORTH_WEST_SOUTH_EAST, @@ -161,7 +183,8 @@ declare namespace pointer { * Cross (accurate selection) * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CROSS, @@ -169,7 +192,8 @@ declare namespace pointer { * Copy * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_COPY, @@ -177,7 +201,8 @@ declare namespace pointer { * Forbid * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_FORBID, @@ -185,7 +210,8 @@ declare namespace pointer { * Sucker * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_SUCKER, @@ -193,7 +219,8 @@ declare namespace pointer { * Grabbing hand * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ HAND_GRABBING, @@ -201,7 +228,8 @@ declare namespace pointer { * Opening hand * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ HAND_OPEN, @@ -209,7 +237,8 @@ declare namespace pointer { * Hand-shaped pointer * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ HAND_POINTING, @@ -217,7 +246,8 @@ declare namespace pointer { * Help * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ HELP, @@ -225,7 +255,8 @@ declare namespace pointer { * Move * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MOVE, @@ -233,7 +264,8 @@ declare namespace pointer { * Left and right resizing * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_LEFT_RIGHT, @@ -241,7 +273,8 @@ declare namespace pointer { * Up and down resizing * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ RESIZE_UP_DOWN, @@ -249,7 +282,8 @@ declare namespace pointer { * Screenshot crosshair * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREENSHOT_CHOOSE, @@ -257,7 +291,8 @@ declare namespace pointer { * Screenshot * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ SCREENSHOT_CURSOR, @@ -265,7 +300,8 @@ declare namespace pointer { * Text selection * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TEXT_CURSOR, @@ -273,7 +309,8 @@ declare namespace pointer { * Zoom in * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ZOOM_IN, @@ -281,7 +318,8 @@ declare namespace pointer { * Zoom out * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ZOOM_OUT, @@ -289,7 +327,8 @@ declare namespace pointer { * Scrolling east * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_EAST, @@ -297,7 +336,8 @@ declare namespace pointer { * Scrolling west * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_WEST, @@ -305,7 +345,8 @@ declare namespace pointer { * Scrolling south * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_SOUTH, @@ -313,7 +354,8 @@ declare namespace pointer { * Scrolling north * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_NORTH, @@ -321,7 +363,8 @@ declare namespace pointer { * Scrolling north and south * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_NORTH_SOUTH, @@ -329,7 +372,8 @@ declare namespace pointer { * Scrolling northeast * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_NORTH_EAST, @@ -337,7 +381,8 @@ declare namespace pointer { * Scrolling northwest * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_NORTH_WEST, @@ -345,7 +390,8 @@ declare namespace pointer { * Scrolling southeast * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_SOUTH_EAST, @@ -353,7 +399,8 @@ declare namespace pointer { * Scrolling southwest * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_SOUTH_WEST, @@ -361,7 +408,8 @@ declare namespace pointer { * Moving as a cone in four directions * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_NORTH_SOUTH_WEST_EAST, @@ -369,7 +417,8 @@ declare namespace pointer { * Horizontal text selection * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ HORIZONTAL_TEXT_CURSOR, @@ -377,7 +426,8 @@ declare namespace pointer { * Precise selection * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_CROSS, @@ -385,7 +435,8 @@ declare namespace pointer { * Cursor with circle style * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ CURSOR_CIRCLE, @@ -393,14 +444,16 @@ declare namespace pointer { * Loading state with dynamic cursor * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Loading state with dynamic cursor * * @syscap SystemCapability.MultimodalInput.Input.Pointer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LOADING, @@ -408,14 +461,16 @@ declare namespace pointer { * Running state with dynamic cursor * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Running state with dynamic cursor * * @syscap SystemCapability.MultimodalInput.Input.Pointer * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ RUNNING, @@ -423,7 +478,8 @@ declare namespace pointer { * Scrolling east and west * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ MIDDLE_BTN_EAST_WEST } @@ -433,21 +489,24 @@ declare namespace pointer { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PrimaryButton { /** * Left mouse button * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ LEFT = 0, /** * Right mouse button * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ RIGHT = 1 } @@ -457,28 +516,32 @@ declare namespace pointer { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ enum RightClickType { /** * Touchpad right button * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCHPAD_RIGHT_BUTTON = 1, /** * Touchpad left button * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCHPAD_LEFT_BUTTON = 2, /** * Touchpad two fingers tap * * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCHPAD_TWO_FINGER_TAP = 3, } @@ -519,14 +582,16 @@ declare namespace pointer { * * @interface CursorConfig * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ interface CursorConfig { /** * followSystem - Whether to adjust the cursor size based on the system settings. * @type { boolean } * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 15 + * @since arkts {'1.1':'15', '1.2':'20'} + * @arkts 1.1&1.2 */ followSystem : boolean; } @@ -651,40 +716,43 @@ declare namespace pointer { /** * Sets the pointer style. * - * @param { number } windowId - Window ID. + * @param { int } windowId - Window ID. * @param { PointerStyle } pointerStyle - Pointer style. * @param { AsyncCallback } callback - Callback used to return the result. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback): void; + function setPointerStyle(windowId: int, pointerStyle: PointerStyle, callback: AsyncCallback): void; /** * Sets the pointer style. * - * @param { number } windowId - Window ID. + * @param { int } windowId - Window ID. * @param { PointerStyle } pointerStyle - Pointer style. * @returns { Promise } Returns the result through a promise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise; + function setPointerStyle(windowId: int, pointerStyle: PointerStyle): Promise; /** * Sets the pointer style through sync mode. * - * @param { number } windowId - Window ID. + * @param { int } windowId - Window ID. * @param { PointerStyle } pointerStyle - Pointer style. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ - function setPointerStyleSync(windowId: number, pointerStyle: PointerStyle): void; + function setPointerStyleSync(windowId: int, pointerStyle: PointerStyle): void; /** * Queries the pointer style. @@ -701,14 +769,15 @@ declare namespace pointer { /** * Queries the pointer style. * - * @param { number } windowId - Window ID. + * @param { int } windowId - Window ID. * @returns { Promise } Returns the result through a promise. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; *
2. Incorrect parameter types; 3. Parameter verification failed. * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - function getPointerStyle(windowId: number): Promise; + function getPointerStyle(windowId: int): Promise; /** * Queries the pointer style through sync mode. @@ -743,7 +812,7 @@ declare namespace pointer { * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported; * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 14 + * @since 18 */ function setPointerVisible(visible: boolean, callback: AsyncCallback): void; @@ -768,7 +837,8 @@ declare namespace pointer { * 2. Incorrect parameter types; 3. Parameter verification failed. * @throws { BusinessError } 801 - Capability not supported; * @syscap SystemCapability.MultimodalInput.Input.Pointer - * @since 14 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setPointerVisible(visible: boolean): Promise; diff --git a/api/@ohos.multimodalInput.touchEvent.d.ts b/api/@ohos.multimodalInput.touchEvent.d.ts index 711139c69db7900793f57922cd0edebcbfc8d6c1..1ecef64bebf5724af99a9f9a9b3554095a5e4454 100644 --- a/api/@ohos.multimodalInput.touchEvent.d.ts +++ b/api/@ohos.multimodalInput.touchEvent.d.ts @@ -18,21 +18,28 @@ * @kit InputKit */ +/*** if arkts 1.1 */ import type { InputEvent } from './@ohos.multimodalInput.inputEvent'; +/*** endif */ +/*** if arkts 1.2 */ +import { InputEvent } from './@ohos.multimodalInput.inputEvent'; +/*** endif */ /** * Action * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum Action { /** * Touch cancelled * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL = 0, @@ -40,7 +47,8 @@ export declare enum Action { * Touch pressed * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ DOWN = 1, @@ -48,7 +56,8 @@ export declare enum Action { * Touch moved * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MOVE = 2, @@ -56,7 +65,8 @@ export declare enum Action { * Touch lifted * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ UP = 3 } @@ -66,14 +76,16 @@ export declare enum Action { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum ToolType { /** * Finger * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ FINGER = 0, @@ -81,7 +93,8 @@ export declare enum ToolType { * Stylus * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PEN = 1, @@ -89,7 +102,8 @@ export declare enum ToolType { * Rubber * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ RUBBER = 2, @@ -97,7 +111,8 @@ export declare enum ToolType { * Brush * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ BRUSH = 3, @@ -105,7 +120,8 @@ export declare enum ToolType { * Pencil * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PENCIL = 4, @@ -113,7 +129,8 @@ export declare enum ToolType { * Air brush * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ AIRBRUSH = 5, @@ -121,7 +138,8 @@ export declare enum ToolType { * Mouse * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MOUSE = 6, @@ -129,7 +147,8 @@ export declare enum ToolType { * lens * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LENS = 7 } @@ -139,14 +158,16 @@ export declare enum ToolType { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum SourceType { /** * Touchscreen * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCH_SCREEN = 0, @@ -154,7 +175,8 @@ export declare enum SourceType { * Stylus * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PEN = 1, @@ -162,7 +184,8 @@ export declare enum SourceType { * Touchpad * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TOUCH_PAD = 2 } @@ -172,14 +195,18 @@ export declare enum SourceType { * * @enum { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @systemapi Hide this for inner system use. + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare enum FixedMode { /** * Not fix. * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @systemapi Hide this for inner system use. + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ NONE = 0, @@ -187,9 +214,11 @@ export declare enum FixedMode { * One hand mode. * * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @systemapi Hide this for inner system use. + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ - ONE_HAND = 1 + AUTO = 1 } /** @@ -197,14 +226,16 @@ export declare enum FixedMode { * * @interface Touch * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface Touch { /** * Pointer identifier * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -212,7 +243,8 @@ export declare interface Touch { * Time stamp when touch is pressed * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ pressedTime: number; @@ -220,7 +252,8 @@ export declare interface Touch { * X coordinate of the touch position on the screen * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ screenX: number; @@ -228,7 +261,8 @@ export declare interface Touch { * Y coordinate of the touch position on the screen * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ screenY: number; @@ -236,7 +270,8 @@ export declare interface Touch { * X coordinate of the touch position in the window * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ windowX: number; @@ -244,7 +279,8 @@ export declare interface Touch { * Y coordinate of the touch position in the window * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ windowY: number; @@ -252,7 +288,8 @@ export declare interface Touch { * Pressure value. The value range is [0.0, 1.0]. The value 0.0 indicates that the pressure is not supported. * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ pressure: number; @@ -260,7 +297,8 @@ export declare interface Touch { * Width of the contact area when touch is pressed * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -268,7 +306,8 @@ export declare interface Touch { * Height of the contact area when touch is pressed * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ height: number; @@ -276,7 +315,8 @@ export declare interface Touch { * Angle relative to the YZ plane. The value range is [-90, 90]. A positive value indicates a rightward tilt. * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ tiltX: number; @@ -284,7 +324,8 @@ export declare interface Touch { * Angle relative to the XZ plane. The value range is [-90, 90]. A positive value indicates a downward tilt. * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ tiltY: number; @@ -292,7 +333,8 @@ export declare interface Touch { * Center point X of the tool area * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ toolX: number; @@ -300,7 +342,8 @@ export declare interface Touch { * Center point Y of the tool area * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ toolY: number; @@ -308,7 +351,8 @@ export declare interface Touch { * Width of the tool area * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ toolWidth: number; @@ -316,7 +360,8 @@ export declare interface Touch { * Height of the tool area * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ toolHeight: number; @@ -324,7 +369,8 @@ export declare interface Touch { * X coordinate of the input device * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rawX: number; @@ -332,7 +378,8 @@ export declare interface Touch { * Y coordinate of the input device * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rawY: number; @@ -340,7 +387,8 @@ export declare interface Touch { * Tool type * @type { ToolType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ toolType: ToolType; @@ -348,7 +396,9 @@ export declare interface Touch { * fixedDisplayX - Corrected value of the screen x coordinate. * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @systemapi Hide this for inner system use. + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ fixedDisplayX?: number; @@ -356,7 +406,9 @@ export declare interface Touch { * fixedDisplayY - Corrected value of the screen y coordinate. * @type { number } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @systemapi Hide this for inner system use. + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ fixedDisplayY?: number; } @@ -367,14 +419,16 @@ export declare interface Touch { * @extends InputEvent * @interface TouchEvent * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export declare interface TouchEvent extends InputEvent { /** * Touch action * @type { Action } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ action: Action; @@ -382,7 +436,8 @@ export declare interface TouchEvent extends InputEvent { * Current touch point * @type { Touch } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ touch: Touch; @@ -390,7 +445,8 @@ export declare interface TouchEvent extends InputEvent { * All touch points * @type { Touch[] } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ touches: Touch[]; @@ -398,7 +454,8 @@ export declare interface TouchEvent extends InputEvent { * Device type of the touch source * @type { SourceType } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ sourceType: SourceType; @@ -407,7 +464,9 @@ export declare interface TouchEvent extends InputEvent { * * @type { FixedMode } * @syscap SystemCapability.MultimodalInput.Input.Core - * @since 18 + * @systemapi Hide this for inner system use. + * @since arkts {'1.1':'19', '1.2':'20'} + * @arkts 1.1&1.2 */ fixedMode?: FixedMode; } \ No newline at end of file diff --git a/api/@ohos.net.connection.d.ts b/api/@ohos.net.connection.d.ts index fe160e86d3ebeb31bc4afe85eba292acb6dbd7b1..e9e78d4cebb7e914063f58ce452fd2a359e008a1 100644 --- a/api/@ohos.net.connection.d.ts +++ b/api/@ohos.net.connection.d.ts @@ -19,8 +19,13 @@ */ import type { AsyncCallback, Callback } from './@ohos.base'; + +/*** if arkts 1.1 */ import type http from './@ohos.net.http'; import type socket from './@ohos.net.socket'; +import { int } from './@ohos.base'; +/*** endif */ + /** * Provides interfaces to manage and use data networks. @@ -41,7 +46,8 @@ import type socket from './@ohos.net.socket'; * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace connection { /** @@ -96,7 +102,7 @@ declare namespace connection { /** * Create a network connection with optional netSpecifier and timeout. * @param { NetSpecifier } [netSpecifier] - Indicates the network specifier. See {@link NetSpecifier}. - * @param { number } [timeout] - The time in milliseconds to attempt looking for a suitable network before + * @param { int } [timeout] - The time in milliseconds to attempt looking for a suitable network before * {@link NetConnection#netUnavailable} is called. * @returns { NetConnection } the NetConnection of the NetSpecifier. * @syscap SystemCapability.Communication.NetManager.Core @@ -105,7 +111,7 @@ declare namespace connection { /** * Create a network connection with optional netSpecifier and timeout. * @param { NetSpecifier } [netSpecifier] - Indicates the network specifier. See {@link NetSpecifier}. - * @param { number } [timeout] - The time in milliseconds to attempt looking for a suitable network before + * @param { int } [timeout] - The time in milliseconds to attempt looking for a suitable network before * {@link NetConnection#netUnavailable} is called. * @returns { NetConnection } the NetConnection of the NetSpecifier. * @syscap SystemCapability.Communication.NetManager.Core @@ -115,15 +121,16 @@ declare namespace connection { /** * Create a network connection with optional netSpecifier and timeout. * @param { NetSpecifier } [netSpecifier] - Indicates the network specifier. See {@link NetSpecifier}. - * @param { number } [timeout] - The time in milliseconds to attempt looking for a suitable network before + * @param { int } [timeout] - The time in milliseconds to attempt looking for a suitable network before * {@link NetConnection#netUnavailable} is called. * @returns { NetConnection } the NetConnection of the NetSpecifier. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - function createNetConnection(netSpecifier?: NetSpecifier, timeout?: number): NetConnection; + function createNetConnection(netSpecifier?: NetSpecifier, timeout?: int): NetConnection; /** * Obtains the data network that is activated by default. @@ -148,7 +155,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultNet(callback: AsyncCallback): void; @@ -174,7 +182,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultNet(): Promise; @@ -200,7 +209,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultNetSync(): NetHandle; @@ -214,7 +224,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getAllNets(callback: AsyncCallback>): void; @@ -227,7 +238,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getAllNets(): Promise>; @@ -240,7 +252,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getAllNetsSync(): Array; @@ -256,7 +269,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback): void; @@ -272,7 +286,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getConnectionProperties(netHandle: NetHandle): Promise; @@ -288,7 +303,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getConnectionPropertiesSync(netHandle: NetHandle): ConnectionProperties; @@ -319,7 +335,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback): void; @@ -350,7 +367,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getNetCapabilities(netHandle: NetHandle): Promise; @@ -381,7 +399,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getNetCapabilitiesSync(netHandle: NetHandle): NetCapabilities; @@ -460,7 +479,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultNetMetered(callback: AsyncCallback): void; @@ -472,7 +492,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultNetMetered(): Promise; @@ -484,7 +505,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultNetMeteredSync(): boolean; @@ -511,7 +533,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function hasDefaultNet(callback: AsyncCallback): void; @@ -535,7 +558,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function hasDefaultNet(): Promise; @@ -547,7 +571,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function hasDefaultNetSync(): boolean; @@ -563,7 +588,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function enableAirplaneMode(callback: AsyncCallback): void; @@ -578,7 +604,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function enableAirplaneMode(): Promise; @@ -594,7 +621,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function disableAirplaneMode(callback: AsyncCallback): void; @@ -609,7 +637,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function disableAirplaneMode(): Promise; @@ -624,7 +653,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function reportNetConnected(netHandle: NetHandle, callback: AsyncCallback): void; @@ -639,7 +669,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function reportNetConnected(netHandle: NetHandle): Promise; @@ -654,7 +685,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function reportNetDisconnected(netHandle: NetHandle, callback: AsyncCallback): void; @@ -669,7 +701,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function reportNetDisconnected(netHandle: NetHandle): Promise; @@ -684,7 +717,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getAddressesByName(host: string, callback: AsyncCallback>): void; @@ -699,7 +733,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ function getAddressesByName(host: string): Promise>; @@ -711,7 +746,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getAppNet(callback: AsyncCallback): void; @@ -721,7 +757,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getAppNet(): Promise; @@ -731,7 +768,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getAppNetSync(): NetHandle; @@ -748,7 +786,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function setAppNet(netHandle: NetHandle, callback: AsyncCallback): void; @@ -765,7 +804,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function setAppNet(netHandle: NetHandle): Promise; @@ -781,7 +821,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultHttpProxy(callback: AsyncCallback): void; @@ -797,7 +838,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getDefaultHttpProxy(): Promise; @@ -810,7 +852,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getGlobalHttpProxy(callback: AsyncCallback): void; @@ -822,7 +865,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getGlobalHttpProxy(): Promise; @@ -832,7 +876,8 @@ declare namespace connection { * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid http proxy. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function setAppHttpProxy(httpProxy: HttpProxy): void; @@ -849,7 +894,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function setGlobalHttpProxy(httpProxy: HttpProxy, callback: AsyncCallback): void; @@ -866,7 +912,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function setGlobalHttpProxy(httpProxy: HttpProxy): Promise; @@ -880,7 +927,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ function setPacUrl(pacUrl: string): void; @@ -890,7 +938,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ function getPacUrl(): string; @@ -921,7 +970,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ function addCustomDnsRule(host: string, ip: Array, callback: AsyncCallback): void; @@ -952,7 +1002,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ function addCustomDnsRule(host: string, ip: Array): Promise; @@ -981,7 +1032,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ function removeCustomDnsRule(host: string, callback: AsyncCallback): void; @@ -1010,7 +1062,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ function removeCustomDnsRule(host: string): Promise; @@ -1024,7 +1077,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function clearCustomDnsRules(callback: AsyncCallback): void; @@ -1037,7 +1091,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function clearCustomDnsRules(): Promise; @@ -1053,7 +1108,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. Only used for system app. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function factoryReset(): Promise; @@ -1076,7 +1132,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetConnection { /** @@ -1321,7 +1378,8 @@ declare namespace connection { * @interface NetSpecifier * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetSpecifier { /** @@ -1335,7 +1393,8 @@ declare namespace connection { * @type {NetCapabilities} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ netCapabilities: NetCapabilities; @@ -1350,7 +1409,8 @@ declare namespace connection { * @type {?string} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bearerPrivateIdentifier?: string; } @@ -1368,7 +1428,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetCapabilityInfo { /** @@ -1384,7 +1445,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ netHandle: NetHandle; @@ -1401,7 +1463,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ netCap: NetCapabilities; } @@ -1425,31 +1488,33 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1': '11', '1.2': '20'} + * @arkts 1.1&1.2 */ export interface NetHandle { /** * Network ID, a value of 0 means that there is no default network, and the other values must be greater than or equal to 100. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @since 8 */ /** * Network ID, a value of 0 means that there is no default network, and the other values must be greater than or equal to 100. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @since 10 */ /** * Network ID, a value of 0 means that there is no default network, and the other values must be greater than or equal to 100. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - netId: number; + netId: int; /** *

Binds a TCPSocket or UDPSocket to the current network. All data flows from @@ -1506,7 +1571,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ getAddressesByName(host: string, callback: AsyncCallback>): void; @@ -1535,7 +1601,8 @@ declare namespace connection { * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ getAddressesByName(host: string): Promise>; @@ -1550,7 +1617,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ getAddressByName(host: string, callback: AsyncCallback): void; @@ -1565,7 +1633,8 @@ declare namespace connection { * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ getAddressByName(host: string): Promise; } @@ -1589,24 +1658,27 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetCapabilities { /** * Uplink (device-to-network) bandwidth. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ - linkUpBandwidthKbps?: number; + linkUpBandwidthKbps?: int; /** * Downstream (network-to-device) bandwidth. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ - linkDownBandwidthKbps?: number; + linkDownBandwidthKbps?: int; /** * Network-specific capabilities. @@ -1619,7 +1691,8 @@ declare namespace connection { * @type {?Array} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ networkCap?: Array; @@ -1642,7 +1715,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bearerTypes: Array; } @@ -1651,21 +1725,24 @@ declare namespace connection { * Get information about network connections. * @interface NetConnectionPropertyInfo * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetConnectionPropertyInfo { /** * Defines the handle of the data network. * @type { NetHandle } * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ netHandle: NetHandle; /** * Defines the network connection properties. * @type { ConnectionProperties } * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ connectionProperties: ConnectionProperties; } @@ -1674,21 +1751,24 @@ declare namespace connection { * Get network status information. * @interface NetBlockStatusInfo * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetBlockStatusInfo { /** * Defines the handle of the data network. * @type { NetHandle } * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ netHandle: NetHandle; /** * Check whether the current state is blocked. * @type { boolean } * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ blocked: boolean; } @@ -1704,7 +1784,8 @@ declare namespace connection { * @enum {number} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum NetCap { /** @@ -1716,7 +1797,8 @@ declare namespace connection { * Indicates that the network can access the carrier's MMSC to send and receive multimedia messages. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_MMS = 0, @@ -1729,7 +1811,8 @@ declare namespace connection { * Indicates that the network traffic is not metered. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_NOT_METERED = 11, @@ -1742,7 +1825,8 @@ declare namespace connection { * Indicates that the network can access the Internet. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_INTERNET = 12, @@ -1755,7 +1839,8 @@ declare namespace connection { * Indicates that the network does not use a VPN. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_NOT_VPN = 15, @@ -1768,14 +1853,16 @@ declare namespace connection { * Indicates that the network is available. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_VALIDATED = 16, /** * Indicates that the network is portal. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_PORTAL = 17, @@ -1783,7 +1870,8 @@ declare namespace connection { * Indicates that the network is checking connectivity. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NET_CAPABILITY_CHECKING_CONNECTIVITY = 31 } @@ -1807,7 +1895,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum NetBearType { /** @@ -1826,7 +1915,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BEARER_CELLULAR = 0, @@ -1846,7 +1936,8 @@ declare namespace connection { * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BEARER_WIFI = 1, @@ -1854,7 +1945,8 @@ declare namespace connection { * Indicates that the network is based on a bluetooth network. * @syscap SystemCapability.Communication.NetManager.Core * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BEARER_BLUETOOTH = 2, @@ -1867,14 +1959,16 @@ declare namespace connection { * Indicates that the network is an Ethernet network. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BEARER_ETHERNET = 3, /** * Indicates that the network is based on a VPN network. * @syscap SystemCapability.Communication.NetManager.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ BEARER_VPN = 4, } @@ -1883,28 +1977,32 @@ declare namespace connection { * Defines the network connection properties. * @interface ConnectionProperties * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ConnectionProperties { /** * Network card name. * @type {string} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ interfaceName: string; /** * Domain. The default value is "". * @type {string} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ domains: string; /** * Link information. * @type {Array} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ linkAddresses: Array; @@ -1912,7 +2010,8 @@ declare namespace connection { * Network address, refer to [NetAddress]. * @type {Array} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ dnses: Array; @@ -1920,24 +2019,27 @@ declare namespace connection { * Routing information. * @type {Array} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ routes: Array; /** * Maximum transmission unit. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ - mtu: number; + mtu: int; } /** * Defines network route information. * @interface RouteInfo * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ export interface RouteInfo { /** @@ -1945,14 +2047,25 @@ declare namespace connection { * @type {string} * @syscap SystemCapability.Communication.NetManager.Core * @since 8 + * @arkts 1.1 */ interface: string; + /** + * Network card name. + * @type {string} + * @syscap SystemCapability.Communication.NetManager.Core + * @since 20 + * @arkts 1.2 + */ + iface: string; + /** * Destination Address * @type {LinkAddress} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ destination: LinkAddress; @@ -1960,7 +2073,8 @@ declare namespace connection { * Gateway address. * @type {NetAddress} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ gateway: NetAddress; @@ -1968,7 +2082,8 @@ declare namespace connection { * Whether a gateway is present. * @type {boolean} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ hasGateway: boolean; @@ -1976,7 +2091,8 @@ declare namespace connection { * Whether the route is the default route. * @type {boolean} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ isDefaultRoute: boolean; } @@ -1985,23 +2101,26 @@ declare namespace connection { * Defines network link information. * @interface LinkAddress * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ export interface LinkAddress { /** * Link address. * @type {NetAddress} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ address: NetAddress; /** * The length of the link address prefix. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core - * @since 8 + * @since arkts {'1.1':'8','1.2':'20'} + * @arkts 1.1&1.2 */ - prefixLength: number; + prefixLength: int; } /** @@ -2015,7 +2134,8 @@ declare namespace connection { * @interface NetAddress * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetAddress { /** @@ -2029,39 +2149,42 @@ declare namespace connection { * @type {string} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ address: string; /** * Address family identifier. The value is 1 for IPv4 and 2 for IPv6. The default value is 1. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetManager.Core * @since 8 */ /** * Address family identifier. The value is 1 for IPv4 and 2 for IPv6. The default value is 1. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - family?: number; + family?: int; /** * Port number. The value ranges from 0 to 65535. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetManager.Core * @since 8 */ /** * Port number. The value ranges from 0 to 65535. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - port?: number; + port?: int; } /** @@ -2075,7 +2198,8 @@ declare namespace connection { * @interface HttpProxy * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface HttpProxy { /** @@ -2089,30 +2213,33 @@ declare namespace connection { * @type {string} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ host: string; /** * Host port. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @since 10 */ /** * Host port. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - port: number; + port: int; /** * Http proxy username. * @type {?string} * @syscap SystemCapability.Communication.NetManager.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ username?: string; @@ -2120,7 +2247,8 @@ declare namespace connection { * Http proxy password. * @type {?string} * @syscap SystemCapability.Communication.NetManager.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ password?: string; @@ -2135,7 +2263,8 @@ declare namespace connection { * @type {Array} * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ exclusionList: Array; } diff --git a/api/@ohos.net.http.d.ts b/api/@ohos.net.http.d.ts index f1749c665707c82d5c9a4e9263523ddcd6bda412..941d24b925ea22bf5ff3ba8d3a6222a5153987b3 100644 --- a/api/@ohos.net.http.d.ts +++ b/api/@ohos.net.http.d.ts @@ -21,6 +21,10 @@ import type { AsyncCallback, Callback } from './@ohos.base'; import type connection from './@ohos.net.connection'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ + /** * Provides http related APIs. * @namespace http @@ -40,7 +44,8 @@ import type connection from './@ohos.net.connection'; * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace http { /** @@ -60,7 +65,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type HttpProxy = connection.HttpProxy; @@ -83,7 +89,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function createHttp(): HttpRequest; @@ -91,27 +98,31 @@ declare namespace http { * Enum for Address Family * @enum {string} * @syscap SystemCapability.Communication.NetStack - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ export enum AddressFamily { /** * Default, can use addresses of all IP versions that your system allows. * @syscap SystemCapability.Communication.NetStack - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 'CURL_IPRESOLVE_WHATEVER', /** * ONLYV4 Uses only IPv4 addresses. * @syscap SystemCapability.Communication.NetStack - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ONLY_V4 = 'CURL_IPRESOLVE_V4', /** * ONLYV6 Uses only IPv6 addresses. * @syscap SystemCapability.Communication.NetStack - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ ONLY_V6 = 'CURL_IPRESOLVE_V6' } @@ -135,7 +146,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface HttpRequestOptions { /** @@ -157,7 +169,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ method?: RequestMethod; @@ -183,7 +196,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ extraData?: string | Object | ArrayBuffer; @@ -206,7 +220,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ expectDataType?: HttpDataType; @@ -229,32 +244,34 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ usingCache?: boolean; /** * [1, 1000], default is 1. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 9 */ /** * [1, 1000], default is 1. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 */ /** * [1, 1000], default is 1. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - priority?: number; + priority?: int; /** * HTTP request header. default is 'content-type': 'application/json' @@ -275,55 +292,58 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ header?: Object; /** * Read timeout period. The default value is 60,000, in ms. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 6 */ /** * Read timeout period. The default value is 60,000, in ms. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 */ /** * Read timeout period. The default value is 60,000, in ms. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - readTimeout?: number; + readTimeout?: int; /** * Connection timeout interval. The default value is 60,000, in ms. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 6 */ /** * Connection timeout interval. The default value is 60,000, in ms. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 */ /** * Connection timeout interval. The default value is 60,000, in ms. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - connectTimeout?: number; + connectTimeout?: int; /** * default is automatically specified by the system. @@ -344,7 +364,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ usingProtocol?: HttpProtocol; @@ -370,7 +391,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ usingProxy?: boolean | HttpProxy; @@ -393,7 +415,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ caPath?: string; @@ -401,7 +424,7 @@ declare namespace http { * Used to set to uploading or downloading the start bytes. The default value is 0. * HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests. * For HTTP PUT uploads this option should not be used, since it may conflict with other options. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ @@ -409,18 +432,19 @@ declare namespace http { * Used to set to uploading or downloading the start bytes. The default value is 0. * HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests. * For HTTP PUT uploads this option should not be used, since it may conflict with other options. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - resumeFrom?: number; + resumeFrom?: int; /** * Used to set to uploading or downloading the end bytes. Translate to the end if not set. * HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests. * For HTTP PUT uploads this option should not be used, since it may conflict with other options. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ @@ -428,12 +452,13 @@ declare namespace http { * Used to set to uploading or downloading the end bytes. Translate to the end if not set. * HTTP standard (RFC 7233 section 3.1) allows servers to ignore range requests. * For HTTP PUT uploads this option should not be used, since it may conflict with other options. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - resumeTo?: number; + resumeTo?: int; /** * Support the application to pass in client certificates, allowing the server to verify the client's identity. @@ -446,7 +471,8 @@ declare namespace http { * @type {?ClientCert} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clientCert?: ClientCert; @@ -465,7 +491,8 @@ declare namespace http { * @type {?string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dnsOverHttps?: string; @@ -484,26 +511,28 @@ declare namespace http { * @type {?Array} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ dnsServers?: Array; /** * The maximum limit of the response body. The default value is 5 * 1024 * 1024, in Byte. * The maximum value is 100 * 1024 *1024, in Byte. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * The maximum limit of the response body. The default value is 5 * 1024 * 1024, in Byte. * The maximum value is 100 * 1024 *1024, in Byte. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - maxLimit?: number; + maxLimit?: int; /** * The data fields which is supported by the HTTP protocol to post @@ -520,7 +549,8 @@ declare namespace http { * @type {?Array} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ multiFormDataList?: Array; @@ -529,7 +559,8 @@ declare namespace http { * {@link CertificatePinning.publicKeyHash}, request will fail. * @type {?(CertificatePinning | CertificatePinning[])} * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ certificatePinning?: CertificatePinning | CertificatePinning[]; @@ -538,7 +569,8 @@ declare namespace http { * @type {?RemoteValidation} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ remoteValidation?: RemoteValidation; @@ -547,7 +579,8 @@ declare namespace http { * @type {?TlsOptions} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ tlsOptions?: TlsOptions; @@ -556,7 +589,8 @@ declare namespace http { * @type {?ServerAuthentication} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ serverAuthentication?: ServerAuthentication; @@ -564,7 +598,8 @@ declare namespace http { * Address family option. * @type {?AddressFamily} * @syscap SystemCapability.Communication.NetStack - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ addressFamily?: AddressFamily; } @@ -574,7 +609,8 @@ declare namespace http { * @typedef ServerAuthentication * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ServerAuthentication { /** @@ -582,7 +618,8 @@ declare namespace http { * @type {Credential} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ credential: Credential; /** @@ -590,7 +627,8 @@ declare namespace http { * @type {?AuthenticationType} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ authenticationType?: AuthenticationType; } @@ -602,7 +640,8 @@ declare namespace http { * @typedef {'system' | TlsConfig} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsOptions = 'system' | TlsConfig; @@ -611,7 +650,8 @@ declare namespace http { * @typedef {'system' | 'skip'} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type RemoteValidation = 'system' | 'skip'; @@ -620,7 +660,8 @@ declare namespace http { * @typedef {'basic' | 'ntlm' | 'digest'} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type AuthenticationType = 'basic' | 'ntlm' | 'digest'; @@ -629,7 +670,8 @@ declare namespace http { * @typedef Credential * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export interface Credential { /** @@ -637,7 +679,8 @@ declare namespace http { * @type {string} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ username: string; /** @@ -645,7 +688,8 @@ declare namespace http { * @type {string} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ password: string; } @@ -655,7 +699,8 @@ declare namespace http { * @typedef TlsConfig * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export interface TlsConfig { /** @@ -663,7 +708,8 @@ declare namespace http { * @type {TlsVersion} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ tlsVersionMin: TlsVersion; /** @@ -671,7 +717,8 @@ declare namespace http { * @type {TlsVersion} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ tlsVersionMax: TlsVersion; /** @@ -679,7 +726,8 @@ declare namespace http { * @type {?CipherSuite[]} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ cipherSuites?: CipherSuite[]; } @@ -690,7 +738,8 @@ declare namespace http { * @typedef {'TLS_AES_128_GCM_SHA256' | 'TLS_AES_256_GCM_SHA384' | 'TLS_CHACHA20_POLY1305_SHA256'} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV13SpecificCipherSuite = 'TLS_AES_128_GCM_SHA256' | 'TLS_AES_256_GCM_SHA384' | 'TLS_CHACHA20_POLY1305_SHA256'; @@ -699,7 +748,8 @@ declare namespace http { * @typedef {'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384'} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV12SpecificCipherSuite = 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' | 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256' | 'TLS_RSA_WITH_AES_128_GCM_SHA256' | 'TLS_RSA_WITH_AES_256_GCM_SHA384'; @@ -708,7 +758,8 @@ declare namespace http { * @typedef {'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV10SpecificCipherSuite = 'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA' | 'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA' | 'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_AES_128_CBC_SHA' | 'TLS_RSA_WITH_AES_256_CBC_SHA' | 'TLS_RSA_WITH_3DES_EDE_CBC_SHA'; @@ -717,7 +768,8 @@ declare namespace http { * @typedef {TlsV13CipherSuite} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type CipherSuite = TlsV13CipherSuite; @@ -726,7 +778,8 @@ declare namespace http { * @typedef {TlsV12CipherSuite | TlsV13SpecificCipherSuite} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV13CipherSuite = TlsV12CipherSuite | TlsV13SpecificCipherSuite; @@ -735,7 +788,8 @@ declare namespace http { * @typedef {TlsV11CipherSuite | TlsV12SpecificCipherSuite} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV12CipherSuite = TlsV11CipherSuite | TlsV12SpecificCipherSuite; @@ -744,7 +798,8 @@ declare namespace http { * @typedef {TlsV10CipherSuite} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV11CipherSuite = TlsV10CipherSuite; @@ -753,7 +808,8 @@ declare namespace http { * @typedef {TlsV10SpecificCipherSuite} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type TlsV10CipherSuite = TlsV10SpecificCipherSuite; @@ -762,14 +818,16 @@ declare namespace http { * @enum {number} * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export enum TlsVersion { /** * Tls version 1.0 * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TLS_V_1_0 = 4, @@ -777,7 +835,8 @@ declare namespace http { * Tls version 1.1 * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TLS_V_1_1 = 5, @@ -785,7 +844,8 @@ declare namespace http { * Tls version 1.2 * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TLS_V_1_2 = 6, @@ -793,7 +853,8 @@ declare namespace http { * Tls version 1.3 * @syscap SystemCapability.Communication.NetStack * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ TLS_V_1_3 = 7 } @@ -809,7 +870,8 @@ declare namespace http { * @interface MultiFormData * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface MultiFormData { /** @@ -823,7 +885,8 @@ declare namespace http { * @type {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -838,7 +901,8 @@ declare namespace http { * @type {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ contentType: string; @@ -853,7 +917,8 @@ declare namespace http { * @type {?string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ remoteFileName?: string; @@ -868,7 +933,8 @@ declare namespace http { * @type {?(string | Object | ArrayBuffer)} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ data?: string | Object | ArrayBuffer; @@ -889,7 +955,8 @@ declare namespace http { * @type {?string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ filePath?: string; } @@ -905,7 +972,8 @@ declare namespace http { * @enum {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum CertType { /** @@ -917,7 +985,8 @@ declare namespace http { * PEM format certificate * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PEM = 'PEM', @@ -930,7 +999,8 @@ declare namespace http { * DER format certificate * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DER = 'DER', @@ -943,7 +1013,8 @@ declare namespace http { * P12 format certificate * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ P12 = 'P12' } @@ -961,7 +1032,8 @@ declare namespace http { * @interface ClientCert * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ClientCert { /** @@ -975,7 +1047,8 @@ declare namespace http { * @type {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ certPath: string; @@ -990,7 +1063,8 @@ declare namespace http { * @type {?CertType} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ certType?: CertType; @@ -1005,7 +1079,8 @@ declare namespace http { * @type {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ keyPath: string; @@ -1020,7 +1095,8 @@ declare namespace http { * @type {?string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ keyPassword?: string; } @@ -1029,21 +1105,24 @@ declare namespace http { * Certificate pinning option. * @interface CertificatePinning * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface CertificatePinning { /** * Public key hash. * @type {string} * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ publicKeyHash: string; /** * Certificate public key hash algorithm. * @type {'SHA-256'} * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ hashAlgorithm: 'SHA-256'; } @@ -1070,7 +1149,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface HttpRequest { /** @@ -1276,7 +1356,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ request(url: string, callback: AsyncCallback): void; @@ -1488,7 +1569,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ request(url: string, options: HttpRequestOptions, callback: AsyncCallback): void; @@ -1700,7 +1782,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ request(url: string, options?: HttpRequestOptions): Promise; @@ -1708,7 +1791,7 @@ declare namespace http { * Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming. * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. - * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, + * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, * should use on_headersReceive and on_dataReceive to get http response. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. @@ -1748,7 +1831,7 @@ declare namespace http { * Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming. * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. - * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, + * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, * should use on_headersReceive and on_dataReceive to get http response. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. @@ -1789,7 +1872,7 @@ declare namespace http { * Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming. * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. - * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, + * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, * should use on_headersReceive and on_dataReceive to get http response. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. @@ -1831,7 +1914,7 @@ declare namespace http { * Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming. * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. - * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, + * @param { AsyncCallback } callback - Returns the callback of requestInStream {@link ResponseCode}, * should use on_headersReceive and on_dataReceive to get http response. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. @@ -1869,16 +1952,17 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - requestInStream(url: string, callback: AsyncCallback): void; + requestInStream(url: string, callback: AsyncCallback): void; /** * Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming. * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}. - * @param { AsyncCallback } callback - the callback of requestInStream. + * @param { AsyncCallback } callback - the callback of requestInStream. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -1918,7 +2002,7 @@ declare namespace http { * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}. - * @param { AsyncCallback } callback - the callback of requestInStream. + * @param { AsyncCallback } callback - the callback of requestInStream. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -1959,7 +2043,7 @@ declare namespace http { * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}. - * @param { AsyncCallback } callback - the callback of requestInStream. + * @param { AsyncCallback } callback - the callback of requestInStream. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -2001,7 +2085,7 @@ declare namespace http { * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } options - Optional parameters {@link HttpRequestOptions}. - * @param { AsyncCallback } callback - the callback of requestInStream. + * @param { AsyncCallback } callback - the callback of requestInStream. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -2038,16 +2122,17 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback): void; + requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback): void; /** * Initiates an HTTP request to a given URL, applicable to scenarios where http response supports streaming. * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}. - * @returns { Promise } the promise returned by the function. + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -2087,7 +2172,7 @@ declare namespace http { * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}. - * @returns { Promise } the promise returned by the function. + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -2128,7 +2213,7 @@ declare namespace http { * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}. - * @returns { Promise } the promise returned by the function. + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -2170,7 +2255,7 @@ declare namespace http { * @permission ohos.permission.INTERNET * @param { string } url - URL for initiating an HTTP request. * @param { HttpRequestOptions } [options] - Optional parameters {@link HttpRequestOptions}. - * @returns { Promise } the promise returned by the function. + * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 2300001 - Unsupported protocol. @@ -2207,9 +2292,10 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - requestInStream(url: string, options?: HttpRequestOptions): Promise; + requestInStream(url: string, options?: HttpRequestOptions): Promise; /** * Destroys an HTTP request. @@ -2227,7 +2313,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ destroy(): void; @@ -2573,7 +2660,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum RequestMethod { /** @@ -2592,7 +2680,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OPTIONS = "OPTIONS", @@ -2612,7 +2701,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ GET = "GET", @@ -2632,7 +2722,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HEAD = "HEAD", @@ -2652,7 +2743,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ POST = "POST", @@ -2672,7 +2764,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PUT = "PUT", @@ -2692,7 +2785,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DELETE = "DELETE", @@ -2712,7 +2806,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ TRACE = "TRACE", @@ -2732,7 +2827,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CONNECT = "CONNECT" } @@ -2756,7 +2852,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum ResponseCode { /** @@ -2775,7 +2872,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OK = 200, @@ -2795,7 +2893,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CREATED, @@ -2815,7 +2914,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ACCEPTED, @@ -2835,7 +2935,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NOT_AUTHORITATIVE, @@ -2855,7 +2956,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NO_CONTENT, @@ -2875,7 +2977,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ RESET, @@ -2895,7 +2998,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PARTIAL, @@ -2915,7 +3019,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MULT_CHOICE = 300, @@ -2938,7 +3043,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MOVED_PERM, @@ -2958,7 +3064,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ MOVED_TEMP, @@ -2978,7 +3085,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ SEE_OTHER, @@ -2998,7 +3106,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NOT_MODIFIED, @@ -3018,7 +3127,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ USE_PROXY, @@ -3038,7 +3148,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BAD_REQUEST = 400, @@ -3058,7 +3169,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UNAUTHORIZED, @@ -3078,7 +3190,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAYMENT_REQUIRED, @@ -3098,7 +3211,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ FORBIDDEN, @@ -3118,7 +3232,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NOT_FOUND, @@ -3138,7 +3253,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BAD_METHOD, @@ -3158,7 +3274,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NOT_ACCEPTABLE, @@ -3178,7 +3295,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PROXY_AUTH, @@ -3198,7 +3316,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CLIENT_TIMEOUT, @@ -3221,7 +3340,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CONFLICT, @@ -3241,7 +3361,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ GONE, @@ -3261,7 +3382,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LENGTH_REQUIRED, @@ -3281,7 +3403,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRECON_FAILED, @@ -3301,7 +3424,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ENTITY_TOO_LARGE, @@ -3321,7 +3445,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ REQ_TOO_LONG, @@ -3341,7 +3466,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UNSUPPORTED_TYPE, @@ -3350,7 +3476,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ RANGE_NOT_SATISFIABLE, @@ -3370,7 +3497,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ INTERNAL_ERROR = 500, @@ -3390,7 +3518,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ NOT_IMPLEMENTED, @@ -3410,7 +3539,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ BAD_GATEWAY, @@ -3430,7 +3560,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ UNAVAILABLE, @@ -3450,7 +3581,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ GATEWAY_TIMEOUT, @@ -3470,7 +3602,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ VERSION } @@ -3494,7 +3627,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum HttpProtocol { @@ -3514,7 +3648,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HTTP1_1, @@ -3534,7 +3669,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ HTTP2, @@ -3551,7 +3687,8 @@ declare namespace http { * Fallback to http2 or http1.1 if needed. * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ HTTP3 } @@ -3575,7 +3712,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum HttpDataType { /** @@ -3594,7 +3732,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ STRING, @@ -3614,7 +3753,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ OBJECT = 1, @@ -3634,7 +3774,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ ARRAY_BUFFER = 2 } @@ -3658,7 +3799,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface HttpResponse { /** @@ -3683,7 +3825,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ result: string | Object | ArrayBuffer; @@ -3712,32 +3855,34 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ resultType: HttpDataType; /** * Server status code. - * @type {ResponseCode | number} + * @type {ResponseCode | int} * @syscap SystemCapability.Communication.NetStack * @since 6 */ /** * Server status code. - * @type {ResponseCode | number} + * @type {ResponseCode | int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 */ /** * Server status code. - * @type {ResponseCode | number} + * @type {ResponseCode | int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - responseCode: ResponseCode | number; + responseCode: ResponseCode | int; /** * All headers in the response from the server. @@ -3758,7 +3903,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ header: Object; @@ -3781,7 +3927,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ cookies: string; @@ -3796,7 +3943,8 @@ declare namespace http { * @type {PerformanceTiming} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ performanceTiming: PerformanceTiming; } @@ -3812,158 +3960,169 @@ declare namespace http { * @interface PerformanceTiming * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface PerformanceTiming { /** * Time taken from startup to DNS resolution completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to DNS resolution completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - dnsTiming: number; + dnsTiming: int; /** * Time taken from startup to TCP connection completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to TCP connection completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - tcpTiming: number; + tcpTiming: int; /** * Time taken from startup to TLS connection completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to TLS connection completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - tlsTiming: number; + tlsTiming: int; /** * Time taken from startup to start sending the first byte, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to start sending the first byte, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - firstSendTiming: number; + firstSendTiming: int; /** * Time taken from startup to receiving the first byte, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to receiving the first byte, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - firstReceiveTiming: number; + firstReceiveTiming: int; /** * Time taken from startup to the completion of the request, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to the completion of the request, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - totalFinishTiming: number; + totalFinishTiming: int; /** * Time taken from startup to completion of all redirection steps, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from startup to completion of all redirection steps, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - redirectTiming: number; + redirectTiming: int; /** * Time taken from HTTP request to header completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from HTTP request to header completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - responseHeaderTiming: number; + responseHeaderTiming: int; /** * Time taken from HTTP Request to body completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from HTTP Request to body completion, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - responseBodyTiming: number; + responseBodyTiming: int; /** * Time taken from HTTP Request to callback to the application, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Time taken from HTTP Request to callback to the application, in milliseconds. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - totalTiming: number; + totalTiming: int; } /** @@ -3985,53 +4144,56 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ export interface DataReceiveProgressInfo { /** * Number of data bytes received. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Number of data bytes received. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 12 */ /** * Number of data bytes received. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - receiveSize: number; + receiveSize: int; /** * Total number of bytes to receive. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Total number of bytes to receive. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 12 */ /** * Total number of bytes to receive. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - totalSize: number; + totalSize: int; } /** @@ -4058,60 +4220,62 @@ declare namespace http { export interface DataSendProgressInfo { /** * Used to specify the data size to be sent. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Used to specify the data size to be sent. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 12 */ /** * Used to specify the data size to be sent. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - sendSize: number; + sendSize: int; /** * Total number of bytes to receive. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @since 11 */ /** * Total number of bytes to receive. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 12 */ /** * Total number of bytes to receive. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - totalSize: number; + totalSize: int; } /** * Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests. - * @param { number } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB). + * @param { int } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB). * @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache. * @syscap SystemCapability.Communication.NetStack * @since 9 */ /** * Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests. - * @param { number } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB). + * @param { int } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB). * @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache. * @syscap SystemCapability.Communication.NetStack * @crossplatform @@ -4119,14 +4283,15 @@ declare namespace http { */ /** * Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests. - * @param { number } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB). + * @param { int } cacheSize - the size of cache(max value is 10MB), default is 10*1024*1024(10MB). * @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache. * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - function createHttpResponseCache(cacheSize?: number): HttpResponseCache; + function createHttpResponseCache(cacheSize?: int): HttpResponseCache; /** * Defines an object that stores the response to an HTTP request. @@ -4147,7 +4312,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface HttpResponseCache { /** @@ -4169,7 +4335,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ flush(callback: AsyncCallback): void; @@ -4192,7 +4359,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ flush(): Promise; @@ -4215,7 +4383,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ delete(callback: AsyncCallback): void; @@ -4238,7 +4407,8 @@ declare namespace http { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ delete(): Promise; } diff --git a/api/@ohos.net.networkSecurity.d.ts b/api/@ohos.net.networkSecurity.d.ts index c5eae54dfe7e37d6cddf421af207390745a0e442..e82a820cd61c37928168af6f94d3db27033b2c20 100644 --- a/api/@ohos.net.networkSecurity.d.ts +++ b/api/@ohos.net.networkSecurity.d.ts @@ -20,31 +20,39 @@ import type { AsyncCallback } from './@ohos.base'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ + /** * Provides networkSecurity related APIs. * @namespace networkSecurity * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace networkSecurity { /** * Defines the certificate type. * @enum {number} * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export enum CertType { /** * PEM type certificate. * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CERT_TYPE_PEM = 0, /** * DER type certificate. * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ CERT_TYPE_DER = 1 } @@ -53,14 +61,16 @@ declare namespace networkSecurity { * Define the certificate content. * @interface CertBlob * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface CertBlob { /** * Certificate type. * @type { CertType } * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: CertType; @@ -68,7 +78,8 @@ declare namespace networkSecurity { * Certificate data. * @type {string | ArrayBuffer} * @syscap SystemCapability.Communication.NetStack - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ data: string | ArrayBuffer; } @@ -77,7 +88,7 @@ declare namespace networkSecurity { * Certificate verification to the server. * @param { CertBlob } cert - Certificates to be verified. * @param { CertBlob } [caCert] - Incoming custom CA cert. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * Number equals 0 if verify of certification from server succeed, else verify failed. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2305001 - Unspecified error. @@ -102,7 +113,7 @@ declare namespace networkSecurity { * Certificate verification to the server. * @param { CertBlob } cert - Certificates to be verified. * @param { CertBlob } [caCert] - Incoming custom CA cert. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * Number equals 0 if verify of certification from server succeed, else verify failed. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2305001 - Unspecified error. @@ -123,9 +134,10 @@ declare namespace networkSecurity { * @throws { BusinessError } 2305027 - Certificate is untrusted. * @throws { BusinessError } 2305069 - Invalid certificate verification context. * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - export function certVerification(cert: CertBlob, caCert?: CertBlob): Promise; + export function certVerification(cert: CertBlob, caCert?: CertBlob): Promise; /** * Certificate verification to the server. @@ -155,7 +167,7 @@ declare namespace networkSecurity { * Certificate verification to the server. * @param { CertBlob } cert - Certificates to be verified. * @param { CertBlob } [caCert] - Incoming custom CA cert. - * @returns { number } Returns 0 if verify of certification from server succeed, else verify failed. + * @returns { int } Returns 0 if verify of certification from server succeed, else verify failed. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2305001 - Unspecified error. * @throws { BusinessError } 2305002 - Unable to get issuer certificate. @@ -175,9 +187,10 @@ declare namespace networkSecurity { * @throws { BusinessError } 2305027 - Certificate is untrusted. * @throws { BusinessError } 2305069 - Invalid certificate verification context. * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - export function certVerificationSync(cert: CertBlob, caCert?: CertBlob): number; + export function certVerificationSync(cert: CertBlob, caCert?: CertBlob): int; /** * Checks whether the Cleartext traffic is permitted. @@ -186,7 +199,8 @@ declare namespace networkSecurity { * @returns { boolean } Returns true if the Cleartext traffic is permitted, else returns false. * @throws { BusinessError } 201 - Permission denied. * @syscap SystemCapability.Communication.NetStack - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export function isCleartextPermitted(): boolean; @@ -198,7 +212,8 @@ declare namespace networkSecurity { * @returns { boolean } Returns true if the Cleartext traffic is permitted, else returns false. * @throws { BusinessError } 201 - Permission denied. * @syscap SystemCapability.Communication.NetStack - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export function isCleartextPermittedByHostName(hostName: string): boolean; } diff --git a/api/@ohos.net.sharing.d.ts b/api/@ohos.net.sharing.d.ts index 74d63c28ce5aa652266de6869ce61cc250b35e19..45267f19ca582af1f78164269f6e9b7bc7b9ae3f 100644 --- a/api/@ohos.net.sharing.d.ts +++ b/api/@ohos.net.sharing.d.ts @@ -21,18 +21,25 @@ import type { AsyncCallback, Callback } from './@ohos.base'; import type connection from './@ohos.net.connection'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ + + /** * Provides network sharing related interfaces. * @namespace sharing * @syscap SystemCapability.Communication.NetManager.NetSharing - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace sharing { /** * Get the handle of the data network. * @typedef { connection.NetHandle } * @syscap SystemCapability.Communication.NetManager.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ type NetHandle = connection.NetHandle; @@ -48,7 +55,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function isSharingSupported(callback: AsyncCallback): void; @@ -63,7 +71,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function isSharingSupported(): Promise; @@ -79,7 +88,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function isSharing(callback: AsyncCallback): void; @@ -94,7 +104,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function isSharing(): Promise; @@ -116,7 +127,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function startSharing(type: SharingIfaceType, callback: AsyncCallback): void; @@ -138,7 +150,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function startSharing(type: SharingIfaceType): Promise; @@ -159,7 +172,8 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function stopSharing(type: SharingIfaceType, callback: AsyncCallback): void; @@ -180,14 +194,15 @@ declare namespace sharing { * @throws { BusinessError } 2202011 - Cannot get network sharing configuration. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function stopSharing(type: SharingIfaceType): Promise; /** * Obtains the number of downlink data bytes of the sharing network interfaces. * @permission ohos.permission.CONNECTIVITY_INTERNAL - * @param { AsyncCallback } callback - Returns the number of downlink data bytes of the sharing network interfaces. + * @param { AsyncCallback } callback - Returns the number of downlink data bytes of the sharing network interfaces. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. @@ -195,29 +210,30 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - function getStatsRxBytes(callback: AsyncCallback): void; + function getStatsRxBytes(callback: AsyncCallback): void; /** * Obtains the number of downlink data bytes of the sharing network interfaces. * @permission ohos.permission.CONNECTIVITY_INTERNAL - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - function getStatsRxBytes(): Promise; + function getStatsRxBytes(): Promise; /** * Obtains the number of uplink data bytes of the sharing network interfaces. * @permission ohos.permission.CONNECTIVITY_INTERNAL - * @param { AsyncCallback } callback - Returns the number of uplink data bytes of the sharing network interfaces. + * @param { AsyncCallback } callback - Returns the number of uplink data bytes of the sharing network interfaces. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. @@ -225,29 +241,30 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - function getStatsTxBytes(callback: AsyncCallback): void; + function getStatsTxBytes(callback: AsyncCallback): void; /** * Obtains the number of uplink data bytes of the sharing network interfaces. * @permission ohos.permission.CONNECTIVITY_INTERNAL - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - function getStatsTxBytes(): Promise; + function getStatsTxBytes(): Promise; /** * Obtains the number of total data bytes of the sharing network interfaces. * @permission ohos.permission.CONNECTIVITY_INTERNAL - * @param { AsyncCallback } callback - Returns the number of total data bytes of the sharing network interfaces. + * @param { AsyncCallback } callback - Returns the number of total data bytes of the sharing network interfaces. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. @@ -255,24 +272,25 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - function getStatsTotalBytes(callback: AsyncCallback): void; + function getStatsTotalBytes(callback: AsyncCallback): void; /** * Obtains the number of total data bytes of the sharing network interfaces. * @permission ohos.permission.CONNECTIVITY_INTERNAL - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. - * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2200002 - Failed to connect to the service. * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ - function getStatsTotalBytes(): Promise; + function getStatsTotalBytes(): Promise; /** * Obtains the names of interfaces in each sharing state. @@ -287,7 +305,8 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback>): void; @@ -304,7 +323,8 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getSharingIfaces(state: SharingIfaceState): Promise>; @@ -321,7 +341,8 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getSharingState(type: SharingIfaceType, callback: AsyncCallback): void; @@ -338,7 +359,8 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getSharingState(type: SharingIfaceType): Promise; @@ -355,7 +377,8 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback>): void; @@ -372,7 +395,8 @@ declare namespace sharing { * @throws { BusinessError } 2200003 - System internal error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function getSharableRegexes(type: SharingIfaceType): Promise>; @@ -489,14 +513,16 @@ declare namespace sharing { * @enum {number} * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export enum SharingIfaceState { /** * Indicates the names of the NICs that are serving as network sharing. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SHARING_NIC_SERVING = 1, @@ -504,7 +530,8 @@ declare namespace sharing { * Indicates the names of the NICs that can serve as network sharing. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SHARING_NIC_CAN_SERVER = 2, @@ -512,7 +539,8 @@ declare namespace sharing { * Indicates the names of the NICs that serving error. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SHARING_NIC_ERROR = 3 } @@ -522,7 +550,8 @@ declare namespace sharing { * @interface InterfaceSharingStateInfo * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface InterfaceSharingStateInfo { /** @@ -530,7 +559,8 @@ declare namespace sharing { * @type { SharingIfaceType } * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type: SharingIfaceType; /** @@ -538,7 +568,8 @@ declare namespace sharing { * @type { string } * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ iface: string; /** @@ -546,7 +577,8 @@ declare namespace sharing { * @type { SharingIfaceState } * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ state: SharingIfaceState; } @@ -556,14 +588,16 @@ declare namespace sharing { * @enum {number} * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ export enum SharingIfaceType { /** * Network sharing type for Wi-Fi. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SHARING_WIFI = 0, @@ -571,7 +605,8 @@ declare namespace sharing { * Network sharing type for USB. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SHARING_USB = 1, @@ -579,7 +614,8 @@ declare namespace sharing { * Network sharing type for BLUETOOTH. * @syscap SystemCapability.Communication.NetManager.NetSharing * @systemapi Hide this for inner system use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ SHARING_BLUETOOTH = 2 } diff --git a/api/@ohos.net.statistics.d.ts b/api/@ohos.net.statistics.d.ts index 1d0e9ec3862e4384641bf750e2e7598c9aca0cfd..83f1e2b762e975bbff3afba9cdb33ef0d3c820f0 100644 --- a/api/@ohos.net.statistics.d.ts +++ b/api/@ohos.net.statistics.d.ts @@ -21,6 +21,10 @@ import type { AsyncCallback, Callback } from './@ohos.base'; import type connection from './@ohos.net.connection'; +/*** if arkts 1.1 */ +import { int, long } from './@ohos.base'; +/*** endif */ + /** * Obtains traffic statistics. * @namespace statistics @@ -32,20 +36,22 @@ import type connection from './@ohos.net.connection'; * @namespace statistics * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace statistics { /** * @typedef {connection.NetBearType} * @syscap SystemCapability.Communication.NetManager.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type NetBearType = connection.NetBearType; /** * Queries the data traffic (including all TCP and UDP data packets) received through a specified NIC. * @param { string } nic - Network interface card. - * @param { AsyncCallback } callback - Returns the data traffic received through the specified NIC. + * @param { AsyncCallback } callback - Returns the data traffic received through the specified NIC. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. @@ -53,14 +59,15 @@ declare namespace statistics { * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getIfaceRxBytes(nic: string, callback: AsyncCallback): void; + function getIfaceRxBytes(nic: string, callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) received through a specified NIC. * @param { string } nic - Network interface card. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. @@ -68,14 +75,15 @@ declare namespace statistics { * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getIfaceRxBytes(nic: string): Promise; + function getIfaceRxBytes(nic: string): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) sent through a specified NIC. * @param { string } nic - Network interface card. - * @param { AsyncCallback } callback - Returns the data traffic sent through the specified NIC. + * @param { AsyncCallback } callback - Returns the data traffic sent through the specified NIC. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. @@ -83,14 +91,15 @@ declare namespace statistics { * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getIfaceTxBytes(nic: string, callback: AsyncCallback): void; + function getIfaceTxBytes(nic: string, callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) sent through a specified NIC. * @param { string } nic - Network interface card. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. @@ -98,65 +107,70 @@ declare namespace statistics { * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getIfaceTxBytes(nic: string): Promise; + function getIfaceTxBytes(nic: string): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) received through the cellular network. - * @param { AsyncCallback } callback - Returns the data traffic received through the cellular network. + * @param { AsyncCallback } callback - Returns the data traffic received through the cellular network. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getCellularRxBytes(callback: AsyncCallback): void; + function getCellularRxBytes(callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) received through the cellular network. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getCellularRxBytes(): Promise; + function getCellularRxBytes(): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) sent through the cellular network. - * @param { AsyncCallback } callback - Returns the data traffic sent through the cellular network. + * @param { AsyncCallback } callback - Returns the data traffic sent through the cellular network. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getCellularTxBytes(callback: AsyncCallback): void; + function getCellularTxBytes(callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) sent through the cellular network. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @throws { BusinessError } 2103012 - Failed to obtain the NIC name. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - function getCellularTxBytes(): Promise; + function getCellularTxBytes(): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. - * @param { AsyncCallback } callback - Returns the data traffic received through all NICs. + * @param { AsyncCallback } callback - Returns the data traffic received through all NICs. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. @@ -166,20 +180,21 @@ declare namespace statistics { */ /** * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. - * @param { AsyncCallback } callback - Returns the data traffic received through all NICs. + * @param { AsyncCallback } callback - Returns the data traffic received through all NICs. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getAllRxBytes(callback: AsyncCallback): void; + function getAllRxBytes(callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. @@ -189,20 +204,21 @@ declare namespace statistics { */ /** * Queries the data traffic (including all TCP and UDP data packets) received through all NICs. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getAllRxBytes(): Promise; + function getAllRxBytes(): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. - * @param { AsyncCallback } callback - Returns the data traffic sent through all NICs. + * @param { AsyncCallback } callback - Returns the data traffic sent through all NICs. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. @@ -212,20 +228,21 @@ declare namespace statistics { */ /** * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. - * @param { AsyncCallback } callback - Returns the data traffic sent through all NICs. + * @param { AsyncCallback } callback - Returns the data traffic sent through all NICs. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getAllTxBytes(callback: AsyncCallback): void; + function getAllTxBytes(callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. @@ -235,78 +252,83 @@ declare namespace statistics { */ /** * Queries the data traffic (including all TCP and UDP data packets) sent through all NICs. - * @returns { Promise } The promise returned by the function. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getAllTxBytes(): Promise; + function getAllTxBytes(): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) received by a specified application. - * @param { number } uid - Indicates the process ID of the application. - * @param { AsyncCallback } callback - Returns the data traffic received by the specified application. + * @param { int } uid - Indicates the process ID of the application. + * @param { AsyncCallback } callback - Returns the data traffic received by the specified application. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getUidRxBytes(uid: number, callback: AsyncCallback): void; + function getUidRxBytes(uid: int, callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) received by a specified application. - * @param { number } uid - Indicates the process ID of the application. - * @returns { Promise } The promise returned by the function. + * @param { int } uid - Indicates the process ID of the application. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getUidRxBytes(uid: number): Promise; + function getUidRxBytes(uid: int): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) sent by a specified application. - * @param { number } uid - Indicates the process ID of the application. - * @param { AsyncCallback } callback - Returns the data traffic sent by the specified application. + * @param { int } uid - Indicates the process ID of the application. + * @param { AsyncCallback } callback - Returns the data traffic sent by the specified application. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getUidTxBytes(uid: number, callback: AsyncCallback): void; + function getUidTxBytes(uid: int, callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) sent by a specified application. - * @param { number } uid - Indicates the process ID of the application. - * @returns { Promise } The promise returned by the function. + * @param { int } uid - Indicates the process ID of the application. + * @returns { Promise } The promise returned by the function. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @throws { BusinessError } 2103005 - Failed to read the system map. * @throws { BusinessError } 2103011 - Failed to create a system map. * @syscap SystemCapability.Communication.NetManager.Core - * @since 10 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ - function getUidTxBytes(uid: number): Promise; + function getUidTxBytes(uid: int): Promise; /** * Register notifications of network traffic updates. * @permission ohos.permission.GET_NETWORK_STATS * @param { 'netStatsChange' } type - Indicates Event name. - * @param { Callback<{ iface: string, uid?: number }> } callback - The callback of on. + * @param { Callback<{ iface: string, uid?: int }> } callback - The callback of on. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. @@ -336,7 +358,7 @@ declare namespace statistics { * Unregister notifications of network traffic updates. * @permission ohos.permission.GET_NETWORK_STATS * @param { 'netStatsChange' } type - Indicates Event name. - * @param { Callback<{ iface: string, uid?: number }> } callback - The callback of off. + * @param { Callback<{ iface: string, uid?: int }> } callback - The callback of off. * @throws { BusinessError } 201 - Permission denied. * @throws { BusinessError } 202 - Non-system applications use system APIs. * @throws { BusinessError } 401 - Parameter error. @@ -376,7 +398,8 @@ declare namespace statistics { * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getTrafficStatsByIface(ifaceInfo: IfaceInfo, callback: AsyncCallback): void; @@ -394,7 +417,8 @@ declare namespace statistics { * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getTrafficStatsByIface(ifaceInfo: IfaceInfo): Promise; @@ -412,7 +436,8 @@ declare namespace statistics { * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getTrafficStatsByUid(uidInfo: UidInfo, callback: AsyncCallback): void; @@ -430,68 +455,74 @@ declare namespace statistics { * @throws { BusinessError } 2103017 - Failed to read the database. * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function getTrafficStatsByUid(uidInfo: UidInfo): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) received through a specified sockfd. - * @param { number } sockfd - Indicates the file descriptor of the given socket. - * @param { AsyncCallback } callback - Returns the data traffic bytes received by the specified sockfd. + * @param { int } sockfd - Indicates the file descriptor of the given socket. + * @param { AsyncCallback } callback - Returns the data traffic bytes received by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - function getSockfdRxBytes(sockfd: number, callback: AsyncCallback): void; + function getSockfdRxBytes(sockfd: int, callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) received through a specified sockfd. - * @param { number } sockfd - Indicates the file descriptor of the given socket. - * @returns { Promise } Returns the data traffic bytes received by the specified sockfd. + * @param { int } sockfd - Indicates the file descriptor of the given socket. + * @returns { Promise } Returns the data traffic bytes received by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value. * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - function getSockfdRxBytes(sockfd: number): Promise; + function getSockfdRxBytes(sockfd: int): Promise; /** * Queries the data traffic (including all TCP and UDP data packets) sent through a specified sockfd. - * @param { number } sockfd - Indicates the file descriptor of the given socket. - * @param { AsyncCallback } callback - Returns the data traffic bytes sent by the specified sockfd. + * @param { int } sockfd - Indicates the file descriptor of the given socket. + * @param { AsyncCallback } callback - Returns the data traffic bytes sent by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - function getSockfdTxBytes(sockfd: number, callback: AsyncCallback): void; + function getSockfdTxBytes(sockfd: int, callback: AsyncCallback): void; /** * Queries the data traffic (including all TCP and UDP data packets) sent through a specified sockfd. - * @param { number } sockfd - Indicates the file descriptor of the given socket. - * @returns { Promise } Returns the data traffic bytes sent by the specified sockfd. + * @param { int } sockfd - Indicates the file descriptor of the given socket. + * @returns { Promise } Returns the data traffic bytes sent by the specified sockfd. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 2100001 - Invalid parameter value * @throws { BusinessError } 2100002 - Failed to connect to the service. * @throws { BusinessError } 2100003 - System internal error. * @syscap SystemCapability.Communication.NetManager.Core - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - function getSockfdTxBytes(sockfd: number): Promise; + function getSockfdTxBytes(sockfd: int): Promise; /** * Parameters for obtaining detailed information on network interface traffic usage. * @interface IfaceInfo * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface IfaceInfo { /** @@ -499,27 +530,30 @@ declare namespace statistics { * @type {string} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ iface: string; /** * Start time for querying traffic. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - startTime: number; + startTime: int; /** * End time for querying traffic. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - endTime: number; + endTime: int; } /** @@ -527,7 +561,8 @@ declare namespace statistics { * @interface UidInfo * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface UidInfo { /** @@ -535,18 +570,20 @@ declare namespace statistics { * @type {IfaceInfo} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ ifaceInfo: IfaceInfo; /** * Uid of app for querying traffic. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - uid: number; + uid: int; } /** @@ -554,44 +591,49 @@ declare namespace statistics { * @interface NetStatsInfo * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetStatsInfo { /** * Bytes of received. - * @type {number} + * @type {long} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - rxBytes: number; + rxBytes: long; /** * Bytes of send. - * @type {number} + * @type {long} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - txBytes: number; + txBytes: long; /** * Packets of received. - * @type {number} + * @type {long} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - rxPackets: number; + rxPackets: long; /** * Packets of send. - * @type {number} + * @type {long} * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ - txPackets: number; + txPackets: long; } /** @@ -599,7 +641,8 @@ declare namespace statistics { * @interface NetStatsChangeInfo * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetStatsChangeInfo { /** @@ -607,17 +650,19 @@ declare namespace statistics { * @type { string } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ iface: string; /** * Network interface for querying traffic. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - uid?: number; + uid?: int; } /** @@ -629,26 +674,29 @@ declare namespace statistics { export type NetStatsInfoSequence = { /** * Start time for querying traffic. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - startTime: number; + startTime: int; /** * End time for querying traffic. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - endTime: number; + endTime: int; /** * Detailed information of statistics. * @type { NetStatsInfo } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ info: NetStatsInfo; }[]; @@ -660,7 +708,7 @@ declare namespace statistics { * @since 12 */ export type UidNetStatsInfo = { - [uid: number]: NetStatsInfo; + [uid: int]: NetStatsInfo; }; /** @@ -668,7 +716,8 @@ declare namespace statistics { * @interface NetworkInfo * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NetworkInfo { /** @@ -676,33 +725,37 @@ declare namespace statistics { * @type { NetBearType } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type: NetBearType; /** * Start time for querying traffic. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - startTime: number; + startTime: int; /** * End time for querying traffic. - * @type { number } + * @type { int } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - endTime: number; + endTime: int; /** * SIM card id for querying traffic. - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Communication.NetManager.Core * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ - simId?: number; + simId?: int; } /** @@ -725,7 +778,7 @@ declare namespace statistics { /** * Get the traffic usage sequence of the specified network of the application in the specified time period. * @permission ohos.permission.GET_NETWORK_STATS - * @param { number } uid - UID with this parameter, get stats info of this UID. + * @param { int } uid - UID with this parameter, get stats info of this UID. * @param { NetworkInfo } networkInfo - Information about the network to be queried. * @returns { Promise } The statistics history of the sim card. * @throws { BusinessError } 201 - Permission denied. @@ -739,7 +792,7 @@ declare namespace statistics { * @systemapi Hide this for inner system use. * @since 12 */ - function getTrafficStatsByUidNetwork(uid: number, networkInfo: NetworkInfo): Promise; + function getTrafficStatsByUidNetwork(uid: int, networkInfo: NetworkInfo): Promise; } export default statistics; \ No newline at end of file diff --git a/api/@ohos.net.webSocket.d.ts b/api/@ohos.net.webSocket.d.ts index 30729c55393cef1d920903fd1ff30cff03c0bc15..da5ff95145f84059e630826fd43cfabfc79d9e94 100644 --- a/api/@ohos.net.webSocket.d.ts +++ b/api/@ohos.net.webSocket.d.ts @@ -21,6 +21,10 @@ import type { AsyncCallback, ErrorCallback, Callback } from './@ohos.base'; import type connection from './@ohos.net.connection'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ + /** * Provides WebSocket APIs. * @namespace webSocket @@ -40,13 +44,15 @@ import type connection from './@ohos.net.connection'; * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace webSocket { /** * @typedef { connection.HttpProxy } * @syscap SystemCapability.Communication.NetManager.Core - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type HttpProxy = connection.HttpProxy; @@ -69,7 +75,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function createWebSocket(): WebSocket; @@ -92,7 +99,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface WebSocketRequestOptions { /** @@ -114,7 +122,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ header?: Object; @@ -129,7 +138,8 @@ declare namespace webSocket { * @type {?string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ caPath?: string; @@ -144,7 +154,8 @@ declare namespace webSocket { * @type {?ClientCert} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ clientCert?: ClientCert; @@ -152,7 +163,8 @@ declare namespace webSocket { * HTTP proxy configuration. Use 'system' if this filed is not set. * @type {?ProxyConfiguration} * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ proxy?: ProxyConfiguration; @@ -160,7 +172,8 @@ declare namespace webSocket { * Self defined protocol. * @type {?string} * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ protocol?: string; } @@ -172,7 +185,8 @@ declare namespace webSocket { * object of @type {connection.HttpProxy} means providing custom proxy settings * @typedef { 'system' | 'no-proxy' | HttpProxy } * @syscap SystemCapability.Communication.NetStack - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type ProxyConfiguration = 'system' | 'no-proxy' | HttpProxy; @@ -191,7 +205,8 @@ declare namespace webSocket { * @interface ClientCert * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface ClientCert { /** @@ -205,7 +220,8 @@ declare namespace webSocket { * @type {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ certPath: string; @@ -220,7 +236,8 @@ declare namespace webSocket { * @type {string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ keyPath: string; @@ -235,7 +252,8 @@ declare namespace webSocket { * @type {?string} * @syscap SystemCapability.Communication.NetStack * @crossplatform - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ keyPassword?: string; } @@ -259,31 +277,33 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface WebSocketCloseOptions { /** * Error code. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @since 6 */ /** * Error code. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 */ /** * Error code. - * @type {?number} + * @type {?int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - code?: number; + code?: int; /** * Error cause. * @type {?string} @@ -303,7 +323,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reason?: string; } @@ -321,25 +342,27 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface CloseResult { /** * Error code. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @since 10 */ /** * Error code. - * @type {number} + * @type {int} * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - code: number; + code: int; /** * Error cause. * @type {string} @@ -353,7 +376,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ reason: string; } @@ -390,7 +414,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ export interface WebSocket { /** @@ -443,7 +468,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ connect(url: string, callback: AsyncCallback): void; @@ -501,7 +527,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback): void; @@ -559,7 +586,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ connect(url: string, options?: WebSocketRequestOptions): Promise; @@ -594,7 +622,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ send(data: string | ArrayBuffer, callback: AsyncCallback): void; @@ -629,7 +658,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ send(data: string | ArrayBuffer): Promise; @@ -661,7 +691,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ close(callback: AsyncCallback): void; @@ -696,7 +727,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ close(options: WebSocketCloseOptions, callback: AsyncCallback): void; @@ -731,7 +763,8 @@ declare namespace webSocket { * @syscap SystemCapability.Communication.NetStack * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ close(options?: WebSocketCloseOptions): Promise; diff --git a/api/@ohos.nfc.cardEmulation.d.ts b/api/@ohos.nfc.cardEmulation.d.ts index 0a088d9bb9237fe4ebea0dd2455be0a0419f1cab..f45d734b44ad57de6cfda1b5b487284c8624d541 100644 --- a/api/@ohos.nfc.cardEmulation.d.ts +++ b/api/@ohos.nfc.cardEmulation.d.ts @@ -35,7 +35,8 @@ import type { AbilityInfo } from './bundleManager/AbilityInfo'; * @namespace cardEmulation * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace cardEmulation { /** @@ -89,7 +90,8 @@ declare namespace cardEmulation { * @enum { string } * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum CardType { /** @@ -103,7 +105,8 @@ declare namespace cardEmulation { * * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ PAYMENT = 'payment', @@ -118,7 +121,8 @@ declare namespace cardEmulation { * * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ OTHER = 'other' } @@ -155,7 +159,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function hasHceCapability(): boolean; @@ -190,7 +195,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function isDefaultService(elementName: ElementName, type: CardType): boolean; @@ -204,7 +210,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getPaymentServices(): AbilityInfo[]; @@ -223,7 +230,8 @@ declare namespace cardEmulation { * * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export class HceService { /** @@ -270,7 +278,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ start(elementName: ElementName, aidList: string[]): void; @@ -315,7 +324,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ stop(elementName: ElementName): void; @@ -339,7 +349,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'hceCmd', callback: AsyncCallback): void; @@ -354,7 +365,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'hceCmd', callback?: AsyncCallback): void; @@ -402,7 +414,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transmit(response: number[]): Promise; @@ -437,7 +450,8 @@ declare namespace cardEmulation { * @throws { BusinessError } 3100301 - Card emulation running state is abnormal in service. * @syscap SystemCapability.Communication.NFC.CardEmulation * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ transmit(response: number[], callback: AsyncCallback): void; } diff --git a/api/@ohos.nfc.controller.d.ts b/api/@ohos.nfc.controller.d.ts index 63aa9d95448cf681bc66adb63f4ea29072d2fb01..f0a866e129a5d53c5d84c96a44c7c1db2a0e1040 100644 --- a/api/@ohos.nfc.controller.d.ts +++ b/api/@ohos.nfc.controller.d.ts @@ -33,7 +33,8 @@ import { Callback } from './@ohos.base'; * @namespace nfcController * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace nfcController { /** @@ -49,7 +50,8 @@ declare namespace nfcController { * @enum { number } * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum NfcState { /** @@ -63,7 +65,8 @@ declare namespace nfcController { * * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_OFF = 1, @@ -78,7 +81,8 @@ declare namespace nfcController { * * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_TURNING_ON = 2, @@ -93,7 +97,8 @@ declare namespace nfcController { * * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_ON = 3, @@ -108,7 +113,8 @@ declare namespace nfcController { * * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ STATE_TURNING_OFF = 4 } @@ -139,7 +145,8 @@ declare namespace nfcController { * @param { Callback } callback Callback used to listen to the nfc state changed event. * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'nfcStateChange', callback: Callback): void; @@ -158,7 +165,8 @@ declare namespace nfcController { * @param { Callback } callback Callback used to listen to the nfc state changed event. * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'nfcStateChange', callback?: Callback): void; @@ -183,7 +191,8 @@ declare namespace nfcController { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100101 - The NFC state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function enableNfc(): void; @@ -208,7 +217,8 @@ declare namespace nfcController { * @throws { BusinessError } 801 - Capability not supported. * @throws { BusinessError } 3100101 - The NFC state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Core - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function disableNfc(): void; @@ -225,7 +235,8 @@ declare namespace nfcController { * @returns { boolean } Returns {@code true} if NFC is enabled; returns {@code false} otherwise. * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function isNfcOpen(): boolean; @@ -250,7 +261,8 @@ declare namespace nfcController { * @returns { NfcState } Returns the NFC status. * @syscap SystemCapability.Communication.NFC.Core * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNfcState(): NfcState; } diff --git a/api/@ohos.nfc.tag.d.ts b/api/@ohos.nfc.tag.d.ts index da104445a27553fd597146f35835b930d0358d21..8c6d5ad85e5a6f6707447fdaa74dd2d33023ae89 100644 --- a/api/@ohos.nfc.tag.d.ts +++ b/api/@ohos.nfc.tag.d.ts @@ -48,7 +48,8 @@ import type { ElementName } from './bundleManager/ElementName'; * @namespace tag * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace tag { /** @@ -64,7 +65,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const NFC_A = 1; @@ -81,7 +83,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const NFC_B = 2; @@ -98,7 +101,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const ISO_DEP = 3; @@ -115,7 +119,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const NFC_F = 4; @@ -132,7 +137,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const NFC_V = 5; @@ -149,7 +155,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const NDEF = 6; @@ -166,7 +173,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const NDEF_FORMATABLE = 7; @@ -183,7 +191,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const MIFARE_CLASSIC = 8; @@ -200,7 +209,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const MIFARE_ULTRALIGHT = 9; @@ -210,7 +220,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ const NFC_BARCODE = 10; @@ -227,7 +238,8 @@ declare namespace tag { * @enum { number } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum TnfType { /** @@ -241,7 +253,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_EMPTY = 0x0, @@ -256,7 +269,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_WELL_KNOWN = 0x1, @@ -271,7 +285,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_MEDIA = 0x2, @@ -286,7 +301,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_ABSOLUTE_URI = 0x3, @@ -301,7 +317,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_EXT_APP = 0x4, @@ -316,7 +333,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_UNKNOWN = 0x5, @@ -331,7 +349,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TNF_UNCHANGED = 0x6 } @@ -349,7 +368,8 @@ declare namespace tag { * @enum { number } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum NfcForumType { /** @@ -363,7 +383,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NFC_FORUM_TYPE_1 = 1, @@ -378,7 +399,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NFC_FORUM_TYPE_2 = 2, @@ -393,7 +415,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NFC_FORUM_TYPE_3 = 3, @@ -408,7 +431,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ NFC_FORUM_TYPE_4 = 4, @@ -423,7 +447,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MIFARE_CLASSIC = 101 } @@ -441,7 +466,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const RTD_TEXT: number[]; @@ -458,7 +484,8 @@ declare namespace tag { * @constant * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ const RTD_URI: number[]; @@ -475,7 +502,8 @@ declare namespace tag { * @enum { number } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MifareClassicType { /** @@ -489,7 +517,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_UNKNOWN = 0, @@ -504,7 +533,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_CLASSIC = 1, @@ -519,7 +549,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_PLUS = 2, @@ -534,7 +565,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_PRO = 3 } @@ -552,7 +584,8 @@ declare namespace tag { * @enum { number } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MifareClassicSize { /** @@ -566,7 +599,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MC_SIZE_MINI = 320, @@ -581,7 +615,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MC_SIZE_1K = 1024, @@ -596,7 +631,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MC_SIZE_2K = 2048, @@ -611,7 +647,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ MC_SIZE_4K = 4096 } @@ -629,7 +666,8 @@ declare namespace tag { * @enum { number } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ enum MifareUltralightType { /** @@ -643,7 +681,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_UNKNOWN = 0, @@ -658,7 +697,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_ULTRALIGHT = 1, @@ -673,7 +713,8 @@ declare namespace tag { * * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_ULTRALIGHT_C = 2 } @@ -723,7 +764,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNfcA(tagInfo: TagInfo): NfcATag; @@ -772,7 +814,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNfcB(tagInfo: TagInfo): NfcBTag; @@ -821,7 +864,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNfcF(tagInfo: TagInfo): NfcFTag; @@ -870,7 +914,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNfcV(tagInfo: TagInfo): NfcVTag; @@ -905,7 +950,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getIsoDep(tagInfo: TagInfo): IsoDepTag; @@ -940,7 +986,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNdef(tagInfo: TagInfo): NdefTag; @@ -975,7 +1022,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getMifareClassic(tagInfo: TagInfo): MifareClassicTag; @@ -1010,7 +1058,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getMifareUltralight(tagInfo: TagInfo): MifareUltralightTag; @@ -1045,7 +1094,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getNdefFormatable(tagInfo: TagInfo): NdefFormatableTag; @@ -1064,7 +1114,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function getBarcodeTag(tagInfo: TagInfo): BarcodeTag; @@ -1093,7 +1144,8 @@ declare namespace tag { * @throws { BusinessError } 801 - Capability not supported. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getTagInfo(want: Want): TagInfo; @@ -1130,7 +1182,8 @@ declare namespace tag { * @throws { BusinessError } 3100202 - The element state is invalid. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function registerForegroundDispatch( elementName: ElementName, @@ -1166,7 +1219,8 @@ declare namespace tag { * @throws { BusinessError } 3100201 - The tag running state is abnormal in the service. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function unregisterForegroundDispatch(elementName: ElementName): void; @@ -1206,7 +1260,8 @@ declare namespace tag { * @throws { BusinessError } 3100202 - The element state is invalid. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'readerMode', elementName: ElementName, discTech: number[], callback: AsyncCallback): void; @@ -1244,7 +1299,8 @@ declare namespace tag { * @throws { BusinessError } 3100203 - The off() API can be called only when the on() has been called. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'readerMode', elementName: ElementName, callback?: AsyncCallback): void; @@ -1265,7 +1321,8 @@ declare namespace tag { * @typedef TagInfo * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface TagInfo { /** @@ -1282,7 +1339,8 @@ declare namespace tag { * @type { number[] } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ uid: number[]; @@ -1300,7 +1358,8 @@ declare namespace tag { * @type { number[] } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ technology: number[]; @@ -1311,7 +1370,8 @@ declare namespace tag { * @type { PacMap[] } * @syscap SystemCapability.Communication.NFC.Tag * @systemapi hide for inner use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ extrasData: PacMap[]; @@ -1322,7 +1382,8 @@ declare namespace tag { * @type { number } * @syscap SystemCapability.Communication.NFC.Tag * @systemapi hide for inner use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ tagRfDiscId: number; @@ -1333,7 +1394,8 @@ declare namespace tag { * @type { rpc.RemoteObject } * @syscap SystemCapability.Communication.NFC.Tag * @systemapi hide for inner use. - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ remoteTagService: rpc.RemoteObject; @@ -1362,7 +1424,8 @@ declare namespace tag { * @typedef NdefRecord * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export interface NdefRecord { /** @@ -1377,7 +1440,8 @@ declare namespace tag { * @type { number } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ tnf: number; @@ -1394,7 +1458,8 @@ declare namespace tag { * @type { number[] } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ rtdType: number[]; @@ -1410,7 +1475,8 @@ declare namespace tag { * @type { number[] } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ id: number[]; @@ -1426,7 +1492,8 @@ declare namespace tag { * @type { number[] } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ payload: number[]; } @@ -1444,7 +1511,8 @@ declare namespace tag { * @namespace ndef * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ namespace ndef { /** @@ -1470,7 +1538,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function makeUriRecord(uri: string): NdefRecord; @@ -1499,7 +1568,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function makeTextRecord(text: string, locale: string): NdefRecord; @@ -1514,7 +1584,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ function makeApplicationRecord(bundleName: string): NdefRecord; @@ -1543,7 +1614,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function makeMimeRecord(mimeType: string, mimeData: number[]): NdefRecord; @@ -1574,7 +1646,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function makeExternalRecord(domainName: string, type: string, externalData: number[]): NdefRecord; /** @@ -1600,7 +1673,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createNdefMessage(data: number[]): NdefMessage; @@ -1627,7 +1701,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function createNdefMessage(ndefRecords: NdefRecord[]): NdefMessage; @@ -1651,7 +1726,8 @@ declare namespace tag { *
3. Parameter verification failed. * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function messageToBytes(ndefMessage: NdefMessage): number[]; } @@ -1668,7 +1744,8 @@ declare namespace tag { * @typedef { _NfcATag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NfcATag = _NfcATag; @@ -1684,7 +1761,8 @@ declare namespace tag { * @typedef { _NfcBTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NfcBTag = _NfcBTag; @@ -1700,7 +1778,8 @@ declare namespace tag { * @typedef { _NfcFTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NfcFTag = _NfcFTag; @@ -1716,7 +1795,8 @@ declare namespace tag { * @typedef { _NfcVTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NfcVTag = _NfcVTag; @@ -1732,7 +1812,8 @@ declare namespace tag { * @typedef { _IsoDepTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type IsoDepTag = _IsoDepTag; @@ -1748,7 +1829,8 @@ declare namespace tag { * @typedef { _NdefTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NdefTag = _NdefTag; @@ -1764,7 +1846,8 @@ declare namespace tag { * @typedef { _MifareClassicTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type MifareClassicTag = _MifareClassicTag; @@ -1780,7 +1863,8 @@ declare namespace tag { * @typedef { _MifareUltralightTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type MifareUltralightTag = _MifareUltralightTag; @@ -1796,7 +1880,8 @@ declare namespace tag { * @typedef { _NdefFormatableTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NdefFormatableTag = _NdefFormatableTag; @@ -1806,7 +1891,8 @@ declare namespace tag { * @typedef { _BarcodeTag } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ export type BarcodeTag = _BarcodeTag; @@ -1822,7 +1908,8 @@ declare namespace tag { * @typedef { _NdefMessage } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type NdefMessage = _NdefMessage; @@ -1838,7 +1925,8 @@ declare namespace tag { * @typedef { _TagSession } * @syscap SystemCapability.Communication.NFC.Tag * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export type TagSession = _TagSession; } diff --git a/api/@ohos.notificationManager.d.ts b/api/@ohos.notificationManager.d.ts index a844fb08b4465900622a6578000ea378e2e2a288..ee9e5e9c832422665d7d107235fcfe9908c22ca6 100644 --- a/api/@ohos.notificationManager.d.ts +++ b/api/@ohos.notificationManager.d.ts @@ -18,17 +18,13 @@ * @kit NotificationKit */ -import { AsyncCallback } from './@ohos.base'; import { BundleOption as _BundleOption } from './notification/NotificationCommonDef'; import { NotificationActionButton as _NotificationActionButton } from './notification/notificationActionButton'; import { NotificationBasicContent as _NotificationBasicContent } from './notification/notificationContent'; import { NotificationContent as _NotificationContent } from './notification/notificationContent'; import { NotificationLongTextContent as _NotificationLongTextContent } from './notification/notificationContent'; -import type { NotificationLiveViewContent as _NotificationLiveViewContent } from './notification/notificationContent'; import { NotificationMultiLineContent as _NotificationMultiLineContent } from './notification/notificationContent'; import { NotificationPictureContent as _NotificationPictureContent } from './notification/notificationContent'; -import type { LiveViewStatus as _LiveViewStatus } from './notification/notificationContent'; -import type { LiveViewTypes as _LiveViewTypes } from './notification/notificationContent'; import { NotificationSystemLiveViewContent as _NotificationSystemLiveViewContent } from './notification/notificationContent'; import { NotificationCapsule as _NotificationCapsule } from './notification/notificationContent'; import { NotificationButton as _NotificationButton } from './notification/notificationContent'; @@ -39,13 +35,29 @@ import { NotificationFlagStatus as _NotificationFlagStatus } from './notificatio import { NotificationRequest as _NotificationRequest } from './notification/notificationRequest'; import { UnifiedGroupInfo as _UnifiedGroupInfo } from './notification/notificationRequest'; import { DistributedOptions as _DistributedOptions } from './notification/notificationRequest'; -import type { NotificationFilter as _NotificationFilter } from './notification/notificationRequest'; -import type { NotificationCheckRequest as _NotificationCheckRequest } from './notification/notificationRequest'; import { NotificationSlot as _NotificationSlot } from './notification/notificationSlot'; import { NotificationSorting as _NotificationSorting } from './notification/notificationSorting'; import { NotificationTemplate as _NotificationTemplate } from './notification/notificationTemplate'; import { NotificationUserInput as _NotificationUserInput } from './notification/notificationUserInput'; + +/*** if arkts 1.1 */ +import { AsyncCallback } from './@ohos.base'; +import type { NotificationLiveViewContent as _NotificationLiveViewContent } from './notification/notificationContent'; +import type { LiveViewStatus as _LiveViewStatus } from './notification/notificationContent'; +import type { LiveViewTypes as _LiveViewTypes } from './notification/notificationContent'; +import type { NotificationFilter as _NotificationFilter } from './notification/notificationRequest'; +import type { NotificationCheckRequest as _NotificationCheckRequest } from './notification/notificationRequest'; +import type UIAbilityContext from './application/UIAbilityContext'; +/*** endif */ +/*** if arkts 1.2 */ +import { AsyncCallback } from '@ohos.base'; +import { NotificationLiveViewContent as _NotificationLiveViewContent } from './notification/notificationContent'; +import { LiveViewStatus as _LiveViewStatus } from './notification/notificationContent'; +import { LiveViewTypes as _LiveViewTypes } from './notification/notificationContent'; +import { NotificationFilter as _NotificationFilter } from './notification/notificationRequest'; +import { NotificationCheckRequest as _NotificationCheckRequest } from './notification/notificationRequest'; import type UIAbilityContext from './application/UIAbilityContext'; +/*** endif */ /** * Manages notifications. @@ -75,7 +87,8 @@ import type UIAbilityContext from './application/UIAbilityContext'; * @syscap SystemCapability.Notification.Notification * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace notificationManager { /** @@ -144,7 +157,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function publish(request: NotificationRequest, callback: AsyncCallback): void; @@ -214,7 +228,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function publish(request: NotificationRequest): Promise; @@ -295,7 +310,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function publish(request: NotificationRequest, userId: number, callback: AsyncCallback): void; @@ -376,7 +392,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function publish(request: NotificationRequest, userId: number): Promise; @@ -406,7 +423,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function publishAsBundle( request: NotificationRequest, @@ -441,7 +459,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise; @@ -470,7 +489,8 @@ declare namespace notificationManager { * @throws { BusinessError } 2300007 - Network unreachable. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function publishAsBundle(representativeBundle: BundleOption, request: NotificationRequest): Promise; @@ -501,7 +521,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancel(id: number, callback: AsyncCallback): void; @@ -518,7 +539,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancel(id: number, label: string, callback: AsyncCallback): void; @@ -535,7 +557,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancel(id: number, label?: string): Promise; @@ -556,7 +579,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600017 - There is no corresponding agent relationship configuration. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancel(representativeBundle: BundleOption, id: number): Promise; @@ -580,7 +604,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelAsBundle( id: number, @@ -609,7 +634,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise; @@ -633,7 +659,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelAsBundle(representativeBundle: BundleOption, id: number): Promise; @@ -660,7 +687,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelAll(callback: AsyncCallback): void; @@ -683,7 +711,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelAll(): Promise; @@ -703,7 +732,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addSlot(slot: NotificationSlot, callback: AsyncCallback): void; @@ -723,7 +753,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addSlot(slot: NotificationSlot): Promise; @@ -739,7 +770,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addSlot(type: SlotType, callback: AsyncCallback): void; @@ -755,7 +787,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addSlot(type: SlotType): Promise; @@ -775,7 +808,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addSlots(slots: Array, callback: AsyncCallback): void; @@ -795,7 +829,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addSlots(slots: Array): Promise; @@ -810,7 +845,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlot(slotType: SlotType, callback: AsyncCallback): void; @@ -825,7 +861,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlot(slotType: SlotType): Promise; @@ -840,7 +877,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlots(callback: AsyncCallback>): void; @@ -852,7 +890,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlots(): Promise>; @@ -868,7 +907,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllNotificationEnabledBundles(): Promise>; @@ -883,7 +923,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeSlot(slotType: SlotType, callback: AsyncCallback): void; @@ -898,7 +939,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeSlot(slotType: SlotType): Promise; @@ -912,7 +954,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAllSlots(callback: AsyncCallback): void; @@ -924,7 +967,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAllSlots(): Promise; @@ -945,7 +989,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setNotificationEnable(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void; @@ -966,7 +1011,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setNotificationEnable(bundle: BundleOption, enable: boolean): Promise; @@ -986,7 +1032,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabled(bundle: BundleOption, callback: AsyncCallback): void; @@ -1006,7 +1053,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabled(bundle: BundleOption): Promise; @@ -1053,7 +1101,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabled(callback: AsyncCallback): void; @@ -1096,7 +1145,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabled(): Promise; @@ -1108,7 +1158,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabledSync(): boolean; @@ -1128,7 +1179,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabled(userId: number, callback: AsyncCallback): void; @@ -1148,7 +1200,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationEnabled(userId: number): Promise; @@ -1189,7 +1242,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function displayBadge(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void; @@ -1230,7 +1284,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function displayBadge(bundle: BundleOption, enable: boolean): Promise; @@ -1269,7 +1324,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isBadgeDisplayed(bundle: BundleOption, callback: AsyncCallback): void; @@ -1308,7 +1364,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isBadgeDisplayed(bundle: BundleOption): Promise; @@ -1349,7 +1406,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSlotByBundle(bundle: BundleOption, slot: NotificationSlot, callback: AsyncCallback): void; @@ -1390,7 +1448,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSlotByBundle(bundle: BundleOption, slot: NotificationSlot): Promise; @@ -1429,7 +1488,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlotsByBundle(bundle: BundleOption, callback: AsyncCallback>): void; @@ -1472,7 +1532,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlotByBundle(bundle: BundleOption, slotType: SlotType): Promise; @@ -1511,7 +1572,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlotsByBundle(bundle: BundleOption): Promise>; @@ -1550,7 +1612,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlotNumByBundle(bundle: BundleOption, callback: AsyncCallback): void; @@ -1589,7 +1652,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlotNumByBundle(bundle: BundleOption): Promise; @@ -1608,7 +1672,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllActiveNotifications(callback: AsyncCallback>): void; @@ -1625,7 +1690,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getAllActiveNotifications(): Promise>; @@ -1639,7 +1705,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getActiveNotificationCount(callback: AsyncCallback): void; @@ -1651,7 +1718,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getActiveNotificationCount(): Promise; @@ -1665,7 +1733,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getActiveNotifications(callback: AsyncCallback>): void; @@ -1677,7 +1746,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getActiveNotifications(): Promise>; @@ -1694,7 +1764,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getActiveNotificationByFilter(filter: NotificationFilter, callback: AsyncCallback): void; @@ -1711,7 +1782,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function getActiveNotificationByFilter(filter: NotificationFilter): Promise; @@ -1726,7 +1798,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelGroup(groupName: string, callback: AsyncCallback): void; @@ -1741,7 +1814,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function cancelGroup(groupName: string): Promise; @@ -1762,7 +1836,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeGroupByBundle(bundle: BundleOption, groupName: string, callback: AsyncCallback): void; @@ -1783,7 +1858,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeGroupByBundle(bundle: BundleOption, groupName: string): Promise; @@ -1822,7 +1898,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDoNotDisturbDate(date: DoNotDisturbDate, callback: AsyncCallback): void; @@ -1861,7 +1938,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDoNotDisturbDate(date: DoNotDisturbDate): Promise; @@ -1904,7 +1982,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDoNotDisturbDate(date: DoNotDisturbDate, userId: number, callback: AsyncCallback): void; @@ -1947,7 +2026,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDoNotDisturbDate(date: DoNotDisturbDate, userId: number): Promise; @@ -1984,7 +2064,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDoNotDisturbDate(callback: AsyncCallback): void; @@ -2017,7 +2098,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDoNotDisturbDate(): Promise; @@ -2058,7 +2140,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDoNotDisturbDate(userId: number, callback: AsyncCallback): void; @@ -2099,7 +2182,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDoNotDisturbDate(userId: number): Promise; @@ -2118,7 +2202,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSupportDoNotDisturbMode(callback: AsyncCallback): void; @@ -2134,7 +2219,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSupportDoNotDisturbMode(): Promise; @@ -2149,7 +2235,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSupportTemplate(templateName: string, callback: AsyncCallback): void; @@ -2164,7 +2251,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSupportTemplate(templateName: string): Promise; @@ -2258,7 +2346,8 @@ declare namespace notificationManager { * @syscap SystemCapability.Notification.Notification * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestEnableNotification(context: UIAbilityContext, callback: AsyncCallback): void; @@ -2346,7 +2435,8 @@ declare namespace notificationManager { * @syscap SystemCapability.Notification.Notification * @StageModelOnly * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function requestEnableNotification(context: UIAbilityContext): Promise; @@ -2385,7 +2475,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDistributedEnable(enable: boolean, callback: AsyncCallback): void; @@ -2424,7 +2515,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDistributedEnable(enable: boolean): Promise; @@ -2440,7 +2532,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDistributedEnabled(callback: AsyncCallback): void; @@ -2453,7 +2546,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @throws { BusinessError } 1600010 - Distributed operation failed. * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDistributedEnabled(): Promise; @@ -2496,7 +2590,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDistributedEnableByBundle(bundle: BundleOption, enable: boolean, callback: AsyncCallback): void; @@ -2539,7 +2634,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDistributedEnableByBundle(bundle: BundleOption, enable: boolean): Promise; @@ -2586,7 +2682,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setDistributedEnabledByBundle(bundle: BundleOption, deviceType: string, enable: boolean): Promise; @@ -2629,7 +2726,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDistributedEnabledByBundle(bundle: BundleOption, callback: AsyncCallback): void; @@ -2670,7 +2768,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDistributedEnabledByBundle(bundle: BundleOption): Promise; @@ -2715,7 +2814,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isDistributedEnabledByBundle(bundle: BundleOption, deviceType: string): Promise; @@ -2760,7 +2860,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSmartReminderEnabled(deviceType: string, enable: boolean): Promise; @@ -2803,7 +2904,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isSmartReminderEnabled(deviceType: string): Promise; @@ -2838,7 +2940,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDeviceRemindType(callback: AsyncCallback): void; @@ -2869,7 +2972,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDeviceRemindType(): Promise; @@ -2934,7 +3038,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setNotificationEnableSlot( bundle: BundleOption, @@ -2988,7 +3093,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setNotificationEnableSlot( bundle: BundleOption, @@ -3063,7 +3169,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setNotificationEnableSlot(bundle: BundleOption, type: SlotType, enable: boolean, isForceControl?: boolean): Promise; @@ -3104,7 +3211,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback): void; @@ -3145,7 +3253,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise; @@ -3186,7 +3295,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: AsyncCallback): void; @@ -3227,7 +3337,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise; @@ -3247,7 +3358,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback): void; @@ -3267,7 +3379,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSyncNotificationEnabledWithoutApp(userId: number): Promise; @@ -3314,7 +3427,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setBadgeNumber(badgeNumber: number, callback: AsyncCallback): void; @@ -3361,7 +3475,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setBadgeNumber(badgeNumber: number): Promise; @@ -3402,7 +3517,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setBadgeNumberByBundle(bundle: BundleOption, badgeNumber: number): Promise; @@ -3433,7 +3549,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600001 - Internal error. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'checkNotification', callback: (checkInfo: NotificationCheckInfo) => NotificationCheckResult): void; @@ -3472,7 +3589,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'checkNotification', checkRequest: NotificationCheckRequest, callback: (checkInfo: NotificationCheckInfo) => Promise): void; @@ -3504,7 +3622,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600001 - Internal error. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function off( type: 'checkNotification', @@ -3552,7 +3671,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function triggerSystemLiveView(bundle: BundleOption, notificationId: number, buttonOptions: ButtonOptions): Promise; @@ -3587,7 +3707,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function subscribeSystemLiveView(subscriber: SystemLiveViewSubscriber): Promise; @@ -3628,7 +3749,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setSlotFlagsByBundle(bundle: BundleOption, slotFlags: number): Promise; @@ -3667,7 +3789,8 @@ declare namespace notificationManager { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getSlotFlagsByBundle(bundle: BundleOption): Promise; @@ -3706,7 +3829,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function addDoNotDisturbProfile(templates: Array): Promise; @@ -3745,7 +3869,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeDoNotDisturbProfile(templates: Array): Promise; @@ -3784,7 +3909,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setAdditionalConfig(key: string, value: string): Promise; @@ -3811,7 +3937,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600018 - the notification settings window is already displayed. * @syscap SystemCapability.Notification.NotificationSettings * @stagemodelonly - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function openNotificationSettings(context: UIAbilityContext): Promise; @@ -3850,7 +3977,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600019 - The do-not-disturb profile does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function getDoNotDisturbProfile(id: number): Promise; @@ -3867,7 +3995,8 @@ declare namespace notificationManager { *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function setTargetDeviceStatus(deviceType: string, status: number): Promise; @@ -3886,7 +4015,8 @@ declare namespace notificationManager { * @throws { BusinessError } 1600002 - Marshalling or unmarshalling error. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function disableNotificationFeature(disabled:boolean, bundleList: Array): Promise; @@ -3904,8 +4034,9 @@ declare namespace notificationManager { *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 - */ + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ function setDistributedEnabledBySlot(slot: SlotType, deviceType: string, enabled: boolean): Promise; /** @@ -3921,8 +4052,9 @@ declare namespace notificationManager { *
2. Incorrect parameter types. 3. Parameter verification failed. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 - */ + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 + */ function isDistributedEnabledBySlot(slot: SlotType, deviceType: string): Promise; /** @@ -3931,7 +4063,8 @@ declare namespace notificationManager { * @typedef ButtonOptions * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface ButtonOptions { /** @@ -3941,7 +4074,8 @@ declare namespace notificationManager { * @type { string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ buttonName: string; } @@ -3952,7 +4086,8 @@ declare namespace notificationManager { * @typedef SystemLiveViewSubscriber * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface SystemLiveViewSubscriber { /** @@ -3961,7 +4096,8 @@ declare namespace notificationManager { * @type { ?function } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ onResponse?: (notificationId: number, buttonOptions: ButtonOptions) => void; } @@ -3972,7 +4108,8 @@ declare namespace notificationManager { * @typedef NotificationCheckInfo * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface NotificationCheckInfo { /** @@ -3982,7 +4119,8 @@ declare namespace notificationManager { * @type { string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -3993,7 +4131,8 @@ declare namespace notificationManager { * @type { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ notificationId: number; @@ -4004,7 +4143,8 @@ declare namespace notificationManager { * @type { ?string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ label?: string; @@ -4015,7 +4155,8 @@ declare namespace notificationManager { * @type { ContentType } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ contentType: ContentType; @@ -4026,7 +4167,8 @@ declare namespace notificationManager { * @type { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ creatorUserId: number; @@ -4037,7 +4179,8 @@ declare namespace notificationManager { * @type { SlotType } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ slotType: SlotType; @@ -4048,7 +4191,8 @@ declare namespace notificationManager { * @type { ?Record } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ extraInfos?: Record; } @@ -4059,7 +4203,8 @@ declare namespace notificationManager { * @typedef NotificationCheckResult * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface NotificationCheckResult { /** @@ -4069,7 +4214,8 @@ declare namespace notificationManager { * @type { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ code: number; @@ -4080,7 +4226,8 @@ declare namespace notificationManager { * @type { string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ message: string; } @@ -4098,7 +4245,8 @@ declare namespace notificationManager { * @enum { number } * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum SlotType { /** @@ -4112,7 +4260,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ UNKNOWN_TYPE = 0, @@ -4127,7 +4276,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SOCIAL_COMMUNICATION = 1, @@ -4142,7 +4292,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SERVICE_INFORMATION = 2, @@ -4157,7 +4308,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CONTENT_INFORMATION = 3, @@ -4172,7 +4324,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ LIVE_VIEW = 4, @@ -4187,7 +4340,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ CUSTOMER_SERVICE = 5, @@ -4196,7 +4350,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ EMERGENCY_INFORMATION = 10, @@ -4211,7 +4366,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ OTHER_TYPES = 0xFFFF } @@ -4230,7 +4386,8 @@ declare namespace notificationManager { * @syscap SystemCapability.Notification.Notification * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum ContentType { /** @@ -4245,7 +4402,8 @@ declare namespace notificationManager { * @syscap SystemCapability.Notification.Notification * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_BASIC_TEXT, @@ -4261,7 +4419,8 @@ declare namespace notificationManager { * @syscap SystemCapability.Notification.Notification * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_LONG_TEXT, @@ -4276,7 +4435,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_PICTURE, @@ -4291,7 +4451,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_CONVERSATION, @@ -4307,7 +4468,8 @@ declare namespace notificationManager { * @syscap SystemCapability.Notification.Notification * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_MULTILINE, @@ -4322,7 +4484,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_SYSTEM_LIVE_VIEW, @@ -4337,7 +4500,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @atomicservice - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_CONTENT_LIVE_VIEW, } @@ -4347,14 +4511,16 @@ declare namespace notificationManager { * * @enum { number } * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum SlotLevel { /** * Indicates that the notification function is disabled. * * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LEVEL_NONE = 0, @@ -4363,7 +4529,8 @@ declare namespace notificationManager { * icons are not displayed in the status bar, with no banner or prompt tone. * * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LEVEL_MIN = 1, @@ -4372,7 +4539,8 @@ declare namespace notificationManager { * icons are displayed in the status bar, with no banner or prompt tone. * * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LEVEL_LOW = 2, @@ -4381,7 +4549,8 @@ declare namespace notificationManager { * icons are displayed in the status bar, with no banner but with a prompt tone. * * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LEVEL_DEFAULT = 3, @@ -4390,7 +4559,8 @@ declare namespace notificationManager { * icons are displayed in the status bar, with a banner and a prompt tone. * * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ LEVEL_HIGH = 4 } @@ -4401,7 +4571,8 @@ declare namespace notificationManager { * @enum { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum DoNotDisturbType { /** @@ -4409,7 +4580,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_NONE = 0, @@ -4418,7 +4590,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_ONCE = 1, @@ -4427,7 +4600,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_DAILY = 2, @@ -4436,7 +4610,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_CLEARLY = 3 } @@ -4447,7 +4622,8 @@ declare namespace notificationManager { * @typedef DoNotDisturbDate * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface DoNotDisturbDate { /** @@ -4456,7 +4632,8 @@ declare namespace notificationManager { * @type { DoNotDisturbType } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ type: DoNotDisturbType; @@ -4466,7 +4643,8 @@ declare namespace notificationManager { * @type { Date } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ begin: Date; @@ -4476,7 +4654,8 @@ declare namespace notificationManager { * @type { Date } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ end: Date; } @@ -4487,7 +4666,8 @@ declare namespace notificationManager { * @typedef DoNotDisturbProfile * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface DoNotDisturbProfile { /** @@ -4496,7 +4676,8 @@ declare namespace notificationManager { * @type { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -4506,7 +4687,8 @@ declare namespace notificationManager { * @type { string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -4516,7 +4698,8 @@ declare namespace notificationManager { * @type { ?Array } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ trustlist?: Array; } @@ -4527,7 +4710,8 @@ declare namespace notificationManager { * @enum { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum DeviceRemindType { /** @@ -4535,7 +4719,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ IDLE_DONOT_REMIND = 0, @@ -4544,7 +4729,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ IDLE_REMIND = 1, @@ -4553,7 +4739,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTIVE_DONOT_REMIND = 2, @@ -4562,7 +4749,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ ACTIVE_REMIND = 3 } @@ -4573,7 +4761,8 @@ declare namespace notificationManager { * @enum { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum SourceType { /** @@ -4581,7 +4770,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_NORMAL = 0, @@ -4590,7 +4780,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_CONTINUOUS = 1, @@ -4599,7 +4790,8 @@ declare namespace notificationManager { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ TYPE_TIMER = 2 } @@ -4610,14 +4802,16 @@ declare namespace notificationManager { * @enum { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum NotificationControlFlagStatus { /** * Manipulating of the enumeration by bitwise-or operation represents the closing of ringtone. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_STATUS_CLOSE_SOUND = 1 << 0, @@ -4625,7 +4819,8 @@ declare namespace notificationManager { * Manipulating of the enumeration by bitwise-or operation represents the closing of lock screen. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_STATUS_CLOSE_LOCKSCREEN = 1 << 1, @@ -4633,7 +4828,8 @@ declare namespace notificationManager { * Manipulating of the enumeration by bitwise-or operation represents the closing of banner. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_STATUS_CLOSE_BANNER = 1 << 2, @@ -4641,7 +4837,8 @@ declare namespace notificationManager { * Manipulating of the enumeration by bitwise-or operation represents the closing of light screen. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_STATUS_CLOSE_LIGHT_SCREEN = 1 << 3, @@ -4649,7 +4846,8 @@ declare namespace notificationManager { * Manipulating of the enumeration by bitwise-or operation represents the closing of vibration. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_STATUS_CLOSE_VIBRATION = 1 << 4, @@ -4657,7 +4855,8 @@ declare namespace notificationManager { * Manipulating of the enumeration by bitwise-or operation represents the closing of status bar icon. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NOTIFICATION_STATUS_CLOSE_STATUSBAR_ICON = 1 << 5 } @@ -4667,7 +4866,8 @@ declare namespace notificationManager { * * @typedef { _BundleOption } BundleOption * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type BundleOption = _BundleOption; @@ -4676,7 +4876,8 @@ declare namespace notificationManager { * * @typedef { _NotificationActionButton } NotificationActionButton * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationActionButton = _NotificationActionButton; @@ -4684,7 +4885,8 @@ declare namespace notificationManager { * Describes a normal text notification. * * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ /** * Describes a normal text notification. @@ -4692,7 +4894,8 @@ declare namespace notificationManager { * @typedef { _NotificationBasicContent } NotificationBasicContent * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationBasicContent = _NotificationBasicContent; @@ -4708,7 +4911,8 @@ declare namespace notificationManager { * @typedef { _NotificationContent } NotificationContent * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationContent = _NotificationContent; @@ -4724,7 +4928,8 @@ declare namespace notificationManager { * @typedef { _NotificationLongTextContent } NotificationLongTextContent * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationLongTextContent = _NotificationLongTextContent; @@ -4734,7 +4939,8 @@ declare namespace notificationManager { * @typedef { _NotificationLiveViewContent } NotificationLiveViewContent * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationLiveViewContent = _NotificationLiveViewContent; @@ -4750,7 +4956,8 @@ declare namespace notificationManager { * @typedef { _NotificationMultiLineContent } NotificationMultiLineContent * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationMultiLineContent = _NotificationMultiLineContent; @@ -4759,7 +4966,8 @@ declare namespace notificationManager { * * @typedef { _NotificationPictureContent } NotificationPictureContent * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationPictureContent = _NotificationPictureContent; @@ -4768,7 +4976,8 @@ declare namespace notificationManager { * * @typedef { _NotificationSystemLiveViewContent } NotificationSystemLiveViewContent * @syscap SystemCapability.Notification.Notification - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationSystemLiveViewContent = _NotificationSystemLiveViewContent; @@ -4778,7 +4987,8 @@ declare namespace notificationManager { * @typedef { _NotificationFlags } NotificationFlags * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationFlags = _NotificationFlags; @@ -4788,7 +4998,8 @@ declare namespace notificationManager { * @typedef { _NotificationFlagStatus } NotificationFlagStatus * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationFlagStatus = _NotificationFlagStatus; @@ -4804,7 +5015,8 @@ declare namespace notificationManager { * @typedef { _NotificationRequest } NotificationRequest * @syscap SystemCapability.Notification.Notification * @crossplatform - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationRequest = _NotificationRequest; @@ -4814,7 +5026,8 @@ declare namespace notificationManager { * @typedef { _UnifiedGroupInfo } UnifiedGroupInfo * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ export type UnifiedGroupInfo = _UnifiedGroupInfo; @@ -4824,7 +5037,8 @@ declare namespace notificationManager { * @typedef { _NotificationFilter } NotificationFilter * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationFilter = _NotificationFilter; @@ -4834,7 +5048,8 @@ declare namespace notificationManager { * @typedef { _NotificationCheckRequest } NotificationCheckRequest * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationCheckRequest = _NotificationCheckRequest; @@ -4843,7 +5058,8 @@ declare namespace notificationManager { * * @typedef { _DistributedOptions } DistributedOptions * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type DistributedOptions = _DistributedOptions; @@ -4852,7 +5068,8 @@ declare namespace notificationManager { * * @typedef { _NotificationSlot } NotificationSlot * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationSlot = _NotificationSlot; @@ -4862,7 +5079,8 @@ declare namespace notificationManager { * @typedef { _LiveViewStatus } LiveViewStatus * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type LiveViewStatus = _LiveViewStatus; @@ -4872,7 +5090,8 @@ declare namespace notificationManager { * @typedef { _LiveViewTypes } LiveViewTypes * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export type LiveViewTypes = _LiveViewTypes; @@ -4882,7 +5101,8 @@ declare namespace notificationManager { * @typedef { _NotificationSorting } NotificationSorting * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationSorting = _NotificationSorting; @@ -4891,7 +5111,8 @@ declare namespace notificationManager { * * @typedef { _NotificationTemplate } NotificationTemplate * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationTemplate = _NotificationTemplate; @@ -4900,7 +5121,8 @@ declare namespace notificationManager { * * @typedef { _NotificationUserInput } NotificationUserInput * @syscap SystemCapability.Notification.Notification - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationUserInput = _NotificationUserInput; @@ -4909,7 +5131,8 @@ declare namespace notificationManager { * * @typedef { _NotificationCapsule } NotificationCapsule * @syscap SystemCapability.Notification.Notification - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationCapsule = _NotificationCapsule; @@ -4918,7 +5141,8 @@ declare namespace notificationManager { * * @typedef { _NotificationButton } NotificationButton * @syscap SystemCapability.Notification.Notification - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationButton = _NotificationButton; @@ -4927,7 +5151,8 @@ declare namespace notificationManager { * * @typedef { _NotificationTime } NotificationTime * @syscap SystemCapability.Notification.Notification - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationTime = _NotificationTime; @@ -4936,7 +5161,8 @@ declare namespace notificationManager { * * @typedef { _NotificationProgress } NotificationProgress * @syscap SystemCapability.Notification.Notification - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationProgress = _NotificationProgress; } diff --git a/api/@ohos.notificationSubscribe.d.ts b/api/@ohos.notificationSubscribe.d.ts index e7f01d8eabf08aefb547e796332addd130879f42..e6dd76a4d17d663a5d59615bbddca53ba748686c 100644 --- a/api/@ohos.notificationSubscribe.d.ts +++ b/api/@ohos.notificationSubscribe.d.ts @@ -24,13 +24,19 @@ import { NotificationSubscribeInfo as _NotificationSubscribeInfo } from './notif import { NotificationSubscriber as _NotificationSubscriber } from './notification/notificationSubscriber'; import { SubscribeCallbackData as _SubscribeCallbackData } from './notification/notificationSubscriber'; import { EnabledNotificationCallbackData as _EnabledNotificationCallbackData } from './notification/notificationSubscriber'; +/*** if arkts 1.1 */ import type { BadgeNumberCallbackData as _BadgeNumberCallbackData } from './notification/notificationSubscriber'; +/*** endif */ +/*** if arkts 1.2 */ +import { BadgeNumberCallbackData as _BadgeNumberCallbackData } from './notification/notificationSubscriber'; +/*** endif */ /** * @namespace notificationSubscribe * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace notificationSubscribe { /** @@ -39,7 +45,8 @@ declare namespace notificationSubscribe { * @typedef NotificationKey * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface NotificationKey { /** @@ -48,7 +55,8 @@ declare namespace notificationSubscribe { * @type { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ id: number; @@ -58,7 +66,8 @@ declare namespace notificationSubscribe { * @type { ?string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ label?: string; } @@ -69,7 +78,8 @@ declare namespace notificationSubscribe { * @enum { number } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum RemoveReason { /** @@ -77,7 +87,8 @@ declare namespace notificationSubscribe { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CLICK_REASON_REMOVE = 1, @@ -86,7 +97,8 @@ declare namespace notificationSubscribe { * * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ CANCEL_REASON_REMOVE = 2 } @@ -107,7 +119,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function subscribe(subscriber: NotificationSubscriber, callback: AsyncCallback): void; @@ -125,7 +138,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ function subscribeSelf(subscriber: NotificationSubscriber): Promise; @@ -146,7 +160,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function subscribe( subscriber: NotificationSubscriber, @@ -171,7 +186,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600012 - No memory space. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function subscribe(subscriber: NotificationSubscriber, info?: NotificationSubscribeInfo): Promise; @@ -190,7 +206,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function unsubscribe(subscriber: NotificationSubscriber, callback: AsyncCallback): void; @@ -209,7 +226,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function unsubscribe(subscriber: NotificationSubscriber): Promise; @@ -232,7 +250,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function remove( bundle: BundleOption, @@ -260,7 +279,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function remove(bundle: BundleOption, notificationKey: NotificationKey, reason: RemoveReason): Promise; @@ -281,7 +301,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function remove(hashCode: string, reason: RemoveReason, callback: AsyncCallback): void; @@ -302,7 +323,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function remove(hashCodes: Array, reason: RemoveReason, callback: AsyncCallback): void; @@ -323,7 +345,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600007 - The notification does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function remove(hashCode: string, reason: RemoveReason): Promise; @@ -343,7 +366,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function remove(hashCodes: Array, reason: RemoveReason): Promise; @@ -363,7 +387,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAll(bundle: BundleOption, callback: AsyncCallback): void; @@ -381,7 +406,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600003 - Failed to connect to the service. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAll(callback: AsyncCallback): void; @@ -401,7 +427,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAll(userId: number, callback: AsyncCallback): void; @@ -421,7 +448,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600008 - The user does not exist. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAll(userId: number): Promise; @@ -441,7 +469,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 17700001 - The specified bundle name was not found. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function removeAll(bundle?: BundleOption): Promise; @@ -460,7 +489,8 @@ declare namespace notificationSubscribe { * @throws { BusinessError } 1600021 - Distributed operation timed out. * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function distributeOperation(hashcode: string, operationInfo?: OperationInfo): Promise; @@ -470,7 +500,8 @@ declare namespace notificationSubscribe { * @typedef OperationInfo * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ export interface OperationInfo { /** @@ -479,7 +510,8 @@ declare namespace notificationSubscribe { * @type { ?string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ actionName?: string; @@ -489,7 +521,8 @@ declare namespace notificationSubscribe { * @type { ?string } * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ userInput?: string; } @@ -500,7 +533,8 @@ declare namespace notificationSubscribe { * @typedef { _BundleOption } BundleOption * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type BundleOption = _BundleOption; @@ -510,7 +544,8 @@ declare namespace notificationSubscribe { * @typedef { _NotificationSubscribeInfo } NotificationSubscribeInfo * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationSubscribeInfo = _NotificationSubscribeInfo; @@ -521,7 +556,8 @@ declare namespace notificationSubscribe { * @typedef { _NotificationSubscriber } NotificationSubscriber * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type NotificationSubscriber = _NotificationSubscriber; @@ -532,7 +568,8 @@ declare namespace notificationSubscribe { * @typedef { _SubscribeCallbackData } SubscribeCallbackData * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type SubscribeCallbackData = _SubscribeCallbackData; @@ -542,7 +579,8 @@ declare namespace notificationSubscribe { * @typedef { _EnabledNotificationCallbackData } EnabledNotificationCallbackData * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export type EnabledNotificationCallbackData = _EnabledNotificationCallbackData; @@ -552,7 +590,8 @@ declare namespace notificationSubscribe { * @typedef { _BadgeNumberCallbackData } BadgeNumberCallbackData * @syscap SystemCapability.Notification.Notification * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ export type BadgeNumberCallbackData = _BadgeNumberCallbackData; } diff --git a/api/@ohos.pasteboard.d.ts b/api/@ohos.pasteboard.d.ts old mode 100755 new mode 100644 index 6e8ab17c15a0864fc79e92eb72d339b36cf71964..ddd320d4b1747da8db66d7be5780d330f8d17309 --- a/api/@ohos.pasteboard.d.ts +++ b/api/@ohos.pasteboard.d.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2021 Huawei Device Co., Ltd. + * 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 @@ -34,7 +34,8 @@ import unifiedDataChannel from './@ohos.data.unifiedDataChannel'; * @namespace pasteboard * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace pasteboard { /** @@ -62,7 +63,8 @@ declare namespace pasteboard { * @constant * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ const MIMETYPE_TEXT_HTML = 'text/html'; /** @@ -90,7 +92,8 @@ declare namespace pasteboard { * @constant * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ const MIMETYPE_TEXT_PLAIN = 'text/plain'; /** @@ -104,7 +107,8 @@ declare namespace pasteboard { * @constant * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ const MIMETYPE_TEXT_URI = 'text/uri'; /** @@ -133,7 +137,8 @@ declare namespace pasteboard { * @typedef { string | image.PixelMap | Want | ArrayBuffer } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ type ValueType = string | image.PixelMap | Want | ArrayBuffer; @@ -193,7 +198,7 @@ declare namespace pasteboard { * @since 9 */ /** - * Creates a PasteData object with MIME type and value. + * Creates a PasteData object of the specified type. * @param { string } mimeType - indicates MIME type of value, its size cannot be greater than 1024 bytes. * @param { ValueType } value - indicates the content that is set to PasteData. * @returns { PasteData } a new PasteData object which contains mimeType and value. @@ -202,7 +207,8 @@ declare namespace pasteboard { * 3. Parameter verification failed. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function createData(mimeType: string, value: ValueType): PasteData; @@ -214,7 +220,8 @@ declare namespace pasteboard { * 2. Incorrect parameters types; * 3. Parameter verification failed. * @syscap SystemCapability.MiscServices.Pasteboard - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ function createData(data: Record): PasteData; @@ -274,10 +281,10 @@ declare namespace pasteboard { * @since 9 */ /** - * Creates a record object with MIME type and value. + * Creates a PasteDataRecord object of the specified type. * @param { string } mimeType - indicates MIME type of value, its size cannot be greater than 1024 bytes. - * @param { ValueType } value - content to be saved. - * @returns { PasteDataRecord } a new PasteDataRecord object which contains mimeType and value. + * @param { ValueType } value - Data content of the specified type. + * @returns { PasteDataRecord } A new paste data record of a specified type. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types; * 3. Parameter verification failed. @@ -298,7 +305,8 @@ declare namespace pasteboard { * @returns { SystemPasteboard } The system clipboard object * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function getSystemPasteboard(): SystemPasteboard; @@ -313,7 +321,8 @@ declare namespace pasteboard { * @enum { number } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum ShareOption { /** @@ -322,10 +331,11 @@ declare namespace pasteboard { * @since 9 */ /** - * INAPP indicates that only paste in the same app is allowed. + * INAPP indicates that only intra-application pasting is allowed. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ INAPP, /** @@ -334,10 +344,11 @@ declare namespace pasteboard { * @since 9 */ /** - * LOCALDEVICE indicates that paste in any app in this device is allowed. + * LOCALDEVICE indicates that paste is allowed in any application. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ LOCALDEVICE, /** @@ -346,7 +357,7 @@ declare namespace pasteboard { * @since 9 */ /** - * CROSSDEVICE indicates that paste in any app across devices is allowed. + * CROSSDEVICE indicates that paste is allowed in any application across devices. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -359,19 +370,22 @@ declare namespace pasteboard { * Enumerates the patterns allowed in the system pasteboard. * @enum { number } * @syscap SystemCapability.MiscServices.Pasteboard - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ enum Pattern { /** * URL pattern. * @syscap SystemCapability.MiscServices.Pasteboard - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ URL = 0, /** * Number pattern. * @syscap SystemCapability.MiscServices.Pasteboard - * @since 13 + * @since arkts {'1.1':'13','1.2':'20'} + * @arkts 1.1&1.2 */ NUMBER = 1, /** @@ -390,11 +404,13 @@ declare namespace pasteboard { * @since 7 */ /** - * Paste data property. + * Defines the properties of all data records on the pasteboard, including the timestamp, data type, pasteable range, + * and additional data. The defined properties can be applied to the pasteboard only with the setProperty method. * @interface PasteDataProperty * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PasteDataProperty { /** @@ -440,7 +456,8 @@ declare namespace pasteboard { * @type { string } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ tag: string; /** @@ -452,13 +469,14 @@ declare namespace pasteboard { */ /** * a timestamp, which indicates when data is written to the system pasteboard. - * @type { number } + * @type { long } * @readonly * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - readonly timestamp: number; + readonly timestamp: long; /** * Checks whether PasteData is set for local access only. * @type { boolean } @@ -486,7 +504,8 @@ declare namespace pasteboard { * @type { ShareOption } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ shareOption: ShareOption; } @@ -502,7 +521,8 @@ declare namespace pasteboard { * @interface PasteDataRecord * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PasteDataRecord { /** @@ -544,7 +564,8 @@ declare namespace pasteboard { * @type { string } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ mimeType: string; /** @@ -558,7 +579,8 @@ declare namespace pasteboard { * @type { string } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ plainText: string; /** @@ -572,7 +594,8 @@ declare namespace pasteboard { * @type { string } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ uri: string; /** @@ -586,7 +609,8 @@ declare namespace pasteboard { * @type { image.PixelMap } * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pixelMap: image.PixelMap; /** @@ -638,7 +662,8 @@ declare namespace pasteboard { * @returns { string } the string returned by the function. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ toPlainText(): string; @@ -674,7 +699,8 @@ declare namespace pasteboard { * 2. Incorrect parameters types; * 3. Parameter verification failed. * @syscap SystemCapability.MiscServices.Pasteboard - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getData(type: string): Promise; } @@ -690,7 +716,8 @@ declare namespace pasteboard { * @interface PasteData * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PasteData { /** @@ -724,7 +751,8 @@ declare namespace pasteboard { * @param { PasteDataRecord } record - The content of a new record. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addRecord(record: PasteDataRecord): void; @@ -778,7 +806,8 @@ declare namespace pasteboard { * 3. Parameter verification failed. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ addRecord(mimeType: string, value: ValueType): void; @@ -793,7 +822,8 @@ declare namespace pasteboard { * @returns { Array } type of array * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getMimeTypes(): Array; @@ -808,7 +838,8 @@ declare namespace pasteboard { * @returns { string } type of htmltext * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getPrimaryHtml(): string; @@ -823,7 +854,8 @@ declare namespace pasteboard { * @returns { Want } type of want * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getPrimaryWant(): Want; @@ -838,7 +870,8 @@ declare namespace pasteboard { * @returns { string } type of mimetype * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getPrimaryMimeType(): string; @@ -853,7 +886,8 @@ declare namespace pasteboard { * @returns { string } type of text * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getPrimaryText(): string; @@ -868,7 +902,8 @@ declare namespace pasteboard { * @returns { string } type of uri * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getPrimaryUri(): string; @@ -898,7 +933,8 @@ declare namespace pasteboard { * @returns { PasteDataProperty } PasteDataProperty type of PasteDataProperty * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getProperty(): PasteDataProperty; @@ -917,7 +953,8 @@ declare namespace pasteboard { * 2. Incorrect parameters types. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setProperty(property: PasteDataProperty): void; @@ -946,16 +983,17 @@ declare namespace pasteboard { */ /** * Gets record by index in PasteData. - * @param { number } index - indicates the record index in PasteData. + * @param { int } index - indicates the record index in PasteData. * @returns { PasteDataRecord } the record in PasteData with index. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. * @throws { BusinessError } 12900001 - The index is out of the record. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - getRecord(index: number): PasteDataRecord; + getRecord(index: int): PasteDataRecord; /** * the number of records in a PasteData object. @@ -965,12 +1003,13 @@ declare namespace pasteboard { */ /** * the number of records in a PasteData object. - * @returns { number } The number of the clipboard contents + * @returns { int } The number of the clipboard contents * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - getRecordCount(): number; + getRecordCount(): int; /** * the user-defined tag of a PasteData object. @@ -983,7 +1022,8 @@ declare namespace pasteboard { * @returns { string } type of tag * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getTag(): string; @@ -1058,7 +1098,7 @@ declare namespace pasteboard { /** * Replaces a specified record with a new one. * @param { number } index - indicates the record index in PasteData. - * @param { PasteDataRecord } record - the content of a new record. + * @param { PasteDataRecord } record - the content of the replaced record. * @returns { boolean } The query returns True on success, or False on failure. * @syscap SystemCapability.MiscServices.Pasteboard * @since 7 @@ -1080,7 +1120,7 @@ declare namespace pasteboard { /** * Replaces a specified record with a new one. * @param { number } index - indicates the record index in PasteData. - * @param { PasteDataRecord } record - the content of a new record. + * @param { PasteDataRecord } record - the content of the replaced record. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. * @throws { BusinessError } 12900001 - The index is out of the record. @@ -1268,7 +1308,8 @@ declare namespace pasteboard { * @interface SystemPasteboard * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface SystemPasteboard { /** @@ -1278,7 +1319,8 @@ declare namespace pasteboard { * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. * @syscap SystemCapability.MiscServices.Pasteboard - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'update', callback: () => void): void; @@ -1290,14 +1332,15 @@ declare namespace pasteboard { * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. * @syscap SystemCapability.MiscServices.Pasteboard - * @since 7 + * @since arkts {'1.1':'7','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'update', callback?: () => void): void; /** * Checks whether the data is remote. * @returns { boolean } True is remote data, else false. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1305,12 +1348,13 @@ declare namespace pasteboard { isRemoteData(): boolean; /** - * Gets source of data. - * @returns { string } data source. - * @throws { BusinessError } 12900005 - Request timed out. + * Obtains the application bundle name of the data source. + * @returns { string } Application bundle name of the data source. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ getDataSource(): string; @@ -1320,10 +1364,11 @@ declare namespace pasteboard { * @returns { boolean } if having mimeType in PasteData returns true, else returns false. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hasDataType(mimeType: string): boolean; @@ -1364,7 +1409,8 @@ declare namespace pasteboard { * 2. Incorrect parameters types. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clearData(callback: AsyncCallback): void; @@ -1379,16 +1425,18 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the clearData. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clearData(): Promise; /** * Clears the pasteboard. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ clearDataSync(): void; @@ -1419,7 +1467,7 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of getData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ @@ -1428,7 +1476,7 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of getData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1441,24 +1489,25 @@ declare namespace pasteboard { * permission required to call the API. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getData(callback: AsyncCallback): void; /** * Gets pastedata from the system pasteboard. * @returns { Promise } the promise returned by the getData. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ /** * Gets pastedata from the system pasteboard. * @returns { Promise } the promise returned by the getData. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1469,17 +1518,18 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the getData. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the * permission required to call the API. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getData(): Promise; /** * Gets pasteData from the system pasteboard. * @returns { PasteData } a new PasteData. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1490,10 +1540,11 @@ declare namespace pasteboard { * @returns { PasteData } a new PasteData. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the * permission required to call the API. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ getDataSync(): PasteData; @@ -1534,7 +1585,8 @@ declare namespace pasteboard { * 2. Incorrect parameters types. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hasData(callback: AsyncCallback): void; @@ -1549,17 +1601,19 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hasData(): Promise; /** * Checks whether there is content in the system pasteboard. * @returns { boolean } True exists, false does not exist. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ hasDataSync(): boolean; @@ -1593,8 +1647,8 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of setData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified. * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ @@ -1604,11 +1658,12 @@ declare namespace pasteboard { * @param { AsyncCallback } callback - the callback of setData. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setData(data: PasteData, callback: AsyncCallback): void; @@ -1618,8 +1673,8 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @since 9 */ @@ -1629,11 +1684,12 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ setData(data: PasteData): Promise; @@ -1642,7 +1698,7 @@ declare namespace pasteboard { * @param { PasteData } data - PasteData will be written to the clipboard. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 11 @@ -1655,7 +1711,7 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the getData. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the * permission required to call the API. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1668,7 +1724,7 @@ declare namespace pasteboard { * @returns { unifiedDataChannel.UnifiedData } a new UnifiedData. * @throws { BusinessError } 201 - Permission verification failed. The application does not have the * permission required to call the API. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1681,8 +1737,8 @@ declare namespace pasteboard { * @returns { Promise } the promise returned by the function. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900004 - Replication is prohibited. + * @throws { BusinessError } 27787277 - Another copy or paste operation is in progress. + * @throws { BusinessError } 27787278 - Replication is prohibited. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1694,7 +1750,7 @@ declare namespace pasteboard { * @param { unifiedDataChannel.UnifiedData } data - Unified data will be written to the pasteboard. * @throws { BusinessError } 401 - Possible causes: 1. Mandatory parameters are left unspecified; * 2. Incorrect parameters types. - * @throws { BusinessError } 12900005 - Request timed out. + * @throws { BusinessError } 12900005 - Excessive processing time for internal data. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 12 @@ -1768,7 +1824,8 @@ declare namespace pasteboard { * @returns { Promise> } Promise used to return the MIME types. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ getMimeTypes(): Promise>; @@ -1792,10 +1849,10 @@ declare namespace pasteboard { * permission required to call the API. * @throws { BusinessError } 401 - Parameter error. * @throws { BusinessError } 12900003 - Another copy or paste operation is in progress. - * @throws { BusinessError } 12900007 - Copy file failed. + * @throws { BusinessError } 12900007 - Invalid destUri or file system error. * @throws { BusinessError } 12900008 - Failed to start progress. * @throws { BusinessError } 12900009 - Progress exits abnormally. - * @throws { BusinessError } 12900010 - Get pasteData error. + * @throws { BusinessError } 12900010 - System error occurred during paste execution. * @syscap SystemCapability.MiscServices.Pasteboard * @atomicservice * @since 15 diff --git a/api/@ohos.pluginComponent.d.ts b/api/@ohos.pluginComponent.d.ts index b0666d852ad2fd587758bbfdd71c7dfc34d22a20..f05f6efee0ef2d8327df09900c90d97f08427e4b 100644 --- a/api/@ohos.pluginComponent.d.ts +++ b/api/@ohos.pluginComponent.d.ts @@ -18,8 +18,10 @@ * @kit ArkUI */ +/*** if arkts 1.1&1.2 */ import { AsyncCallback } from './@ohos.base'; import Want from './@ohos.app.ability.Want'; +/*** endif */ /** * Plugin component template property. @@ -34,7 +36,8 @@ import Want from './@ohos.app.ability.Want'; * @interface PluginComponentTemplate * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PluginComponentTemplate { /** @@ -50,7 +53,8 @@ interface PluginComponentTemplate { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ source: string; @@ -67,7 +71,8 @@ interface PluginComponentTemplate { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ ability: string; } @@ -85,7 +90,8 @@ interface PluginComponentTemplate { * @namespace pluginComponentManager * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace pluginComponentManager { /** @@ -104,6 +110,17 @@ declare namespace pluginComponentManager { * @since 12 */ type KVObject = { [key: string]: number | string | boolean | [] | KVObject } + + /** + * Defines KVObject + * + * @typedef { Record } KVObject + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + type KVObject = Record /** * Plugin component push parameters. @@ -118,7 +135,8 @@ declare namespace pluginComponentManager { * @interface PushParameters * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface PushParameters { /** @@ -134,7 +152,8 @@ declare namespace pluginComponentManager { * @type { Want } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ want: Want; @@ -151,7 +170,8 @@ declare namespace pluginComponentManager { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -168,7 +188,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ data: KVObject; @@ -185,7 +206,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ extraData: KVObject; @@ -202,7 +224,8 @@ declare namespace pluginComponentManager { * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ jsonPath?: string; } @@ -213,7 +236,8 @@ declare namespace pluginComponentManager { * @interface PushParameterForStage * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface PushParameterForStage { /** @@ -222,7 +246,8 @@ declare namespace pluginComponentManager { * @type { Want } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ owner: Want; @@ -232,7 +257,8 @@ declare namespace pluginComponentManager { * @type { Want } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ target: Want; @@ -242,7 +268,8 @@ declare namespace pluginComponentManager { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -252,7 +279,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ data: KVObject; @@ -262,7 +290,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ extraData: KVObject; @@ -272,7 +301,8 @@ declare namespace pluginComponentManager { * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ jsonPath?: string; } @@ -290,7 +320,8 @@ declare namespace pluginComponentManager { * @interface RequestParameters * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestParameters { /** @@ -306,7 +337,8 @@ declare namespace pluginComponentManager { * @type { Want } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ want: Want; @@ -323,7 +355,8 @@ declare namespace pluginComponentManager { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -340,7 +373,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ data: KVObject; @@ -357,7 +391,8 @@ declare namespace pluginComponentManager { * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ jsonPath?: string; } @@ -368,7 +403,8 @@ declare namespace pluginComponentManager { * @interface RequestParameterForStage * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestParameterForStage { /** @@ -377,7 +413,8 @@ declare namespace pluginComponentManager { * @type { Want } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ owner: Want; @@ -387,7 +424,8 @@ declare namespace pluginComponentManager { * @type { Want } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ target: Want; /** @@ -396,7 +434,8 @@ declare namespace pluginComponentManager { * @type { string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -406,7 +445,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ data: KVObject; @@ -416,7 +456,8 @@ declare namespace pluginComponentManager { * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ jsonPath?: string; } @@ -434,7 +475,8 @@ declare namespace pluginComponentManager { * @interface RequestCallbackParameters * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestCallbackParameters { @@ -451,7 +493,8 @@ declare namespace pluginComponentManager { * @type { PluginComponentTemplate } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ componentTemplate: PluginComponentTemplate; @@ -468,7 +511,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ data: KVObject; @@ -485,7 +529,8 @@ declare namespace pluginComponentManager { * @type { KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ extraData: KVObject; } @@ -503,7 +548,8 @@ declare namespace pluginComponentManager { * @interface RequestEventResult * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ interface RequestEventResult { /** @@ -519,7 +565,8 @@ declare namespace pluginComponentManager { * @type { ?string } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ template?: string; @@ -536,7 +583,8 @@ declare namespace pluginComponentManager { * @type { ?KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ data?: KVObject; @@ -553,7 +601,8 @@ declare namespace pluginComponentManager { * @type { ?KVObject } * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ extraData?: KVObject; } @@ -571,7 +620,8 @@ declare namespace pluginComponentManager { * @typedef { function } OnPushEventCallback * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type OnPushEventCallback = (source: Want, template: PluginComponentTemplate, data: KVObject, extraData: KVObject) => void; @@ -590,7 +640,8 @@ declare namespace pluginComponentManager { * @returns { RequestEventResult } Returns the request event result. * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ type OnRequestEventCallback = (source: Want, name: string, data: KVObject) => RequestEventResult; @@ -609,7 +660,8 @@ declare namespace pluginComponentManager { * @param { AsyncCallback } callback * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function push(param: PushParameters, callback: AsyncCallback): void; @@ -628,7 +680,8 @@ declare namespace pluginComponentManager { * @param { AsyncCallback } callback * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function request(param: RequestParameters, callback: AsyncCallback): void; @@ -640,7 +693,8 @@ declare namespace pluginComponentManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function push(param: PushParameterForStage, callback: AsyncCallback): void; @@ -652,7 +706,8 @@ declare namespace pluginComponentManager { * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi * @StageModelOnly - * @since 9 + * @since arkts {'1.1':'9','1.2':'20'} + * @arkts 1.1&1.2 */ function request(param: RequestParameterForStage, callback: AsyncCallback): void; @@ -671,7 +726,8 @@ declare namespace pluginComponentManager { * @param { OnPushEventCallback | OnRequestEventCallback } callback * @syscap SystemCapability.ArkUI.ArkUI.Full * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function on(eventType: string, callback: OnPushEventCallback | OnRequestEventCallback): void; } diff --git a/api/@ohos.power.d.ts b/api/@ohos.power.d.ts index 4b41504996fb80e88258f770f724eb83aaa56649..0c92755ea5a6cf31cc62f6e11ab093030ee8bd3e 100644 --- a/api/@ohos.power.d.ts +++ b/api/@ohos.power.d.ts @@ -19,13 +19,17 @@ */ import { AsyncCallback, BusinessError } from './@ohos.base'; +/*** if arkts 1.1 */ +import { int } from './@ohos.base'; +/*** endif */ /** * Provides interfaces to manage power. * * @namespace power * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace power { /** @@ -41,7 +45,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 7 + * @since arkts {'1.1':'7', '1.2':'20'} + * @arkts 1.1&1.2 */ function shutdown(reason: string): void; @@ -73,7 +78,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function reboot(reason: string): void; @@ -107,7 +113,8 @@ declare namespace power { * @returns { boolean } Returns true if the device is active; returns false otherwise. * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function isActive(): boolean; @@ -135,7 +142,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function wakeup(detail: string): void; @@ -171,7 +179,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function suspend(isImmediate?: boolean): void; @@ -181,7 +190,8 @@ declare namespace power { * @returns { DevicePowerMode } The power mode {@link DevicePowerMode} of current device . * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function getPowerMode(): DevicePowerMode; @@ -198,7 +208,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setPowerMode(mode: DevicePowerMode, callback: AsyncCallback): void; @@ -215,7 +226,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function setPowerMode(mode: DevicePowerMode): Promise; @@ -225,7 +237,8 @@ declare namespace power { * @returns { boolean } Returns true if the device is in idle mode; returns false otherwise. * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 10 + * @since arkts {'1.1':'10', '1.2':'20'} + * @arkts 1.1&1.2 */ function isStandby(): boolean; @@ -251,7 +264,8 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ function hibernate(clearMemory: boolean): void; @@ -277,44 +291,65 @@ declare namespace power { * @throws { BusinessError } 4900101 - Failed to connect to the service. * @syscap SystemCapability.PowerManager.PowerManager.Core * @systemapi - * @since 18 + * @since 19 */ function setScreenOffTime(timeout: number): void; + /** + * Sets the timeout duration(ms) for turning off the screen with permission. + * + * @permission ohos.permission.POWER_MANAGER + * @param { long } timeout - Indicates duration(ms) for turning off the screen. The value -1 means restore the default value. + * @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API. + * @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. + * @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Parameter verification failed. + * @throws { BusinessError } 4900101 - Failed to connect to the service. + * @syscap SystemCapability.PowerManager.PowerManager.Core + * @systemapi + * @since 20 + * @arkts 1.2 + */ + function setScreenOffTime(timeout: long): void; + /** * Power mode of a device. * - * @enum { number } + * @enum { int } * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ export enum DevicePowerMode { /** * Normal power mode * * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MODE_NORMAL = 600, /** * Power save mode - * * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 + * */ MODE_POWER_SAVE, /** * Performance power mode * * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MODE_PERFORMANCE, /** * Extreme power save mode * * @syscap SystemCapability.PowerManager.PowerManager.Core - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ MODE_EXTREME_POWER_SAVE } diff --git a/api/@ohos.print.d.ts b/api/@ohos.print.d.ts index f78f22a71e800b7be52a2cbbe1bb1cbc43d06fef..284eb649ee00af62155a5cd373bf3538b56d195a 100644 --- a/api/@ohos.print.d.ts +++ b/api/@ohos.print.d.ts @@ -26,7 +26,8 @@ import type Context from './application/Context'; * * @namespace print * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace print { @@ -34,7 +35,8 @@ declare namespace print { * PrintTask provide event callback. * @interface PrintTask * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintTask { /** @@ -45,7 +47,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'block', callback: Callback): void; @@ -57,7 +60,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'succeed', callback: Callback): void; @@ -69,7 +73,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'fail', callback: Callback): void; @@ -81,7 +86,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ on(type: 'cancel', callback: Callback): void; @@ -93,7 +99,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'block', callback?: Callback): void; @@ -105,7 +112,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'succeed', callback?: Callback): void; @@ -117,7 +125,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'fail', callback?: Callback): void; @@ -129,7 +138,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ off(type: 'cancel', callback?: Callback): void; } @@ -138,7 +148,8 @@ declare namespace print { * Third-party application implement this interface to render files to be printed. * @interface PrintDocumentAdapter * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintDocumentAdapter { @@ -153,7 +164,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onStartLayoutWrite(jobId: string, oldAttrs: PrintAttributes, newAttrs: PrintAttributes, fd: number, writeResultCallback: (jobId: string, writeResult: PrintFileCreationState) => void): void; @@ -166,7 +178,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ onJobStateChanged(jobId: string, state: PrintDocumentAdapterState): void; } @@ -179,7 +192,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function print(files: Array, callback: AsyncCallback): void; @@ -191,7 +205,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function print(files: Array): Promise; @@ -204,7 +219,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function print(files: Array, context: Context, callback: AsyncCallback): void; @@ -217,7 +233,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function print(files: Array, context: Context): Promise; @@ -232,7 +249,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function print(jobName: string, printAdapter: PrintDocumentAdapter, printAttributes: PrintAttributes, context: Context): Promise; @@ -241,14 +259,16 @@ declare namespace print { * defines print attributes. * @typedef PrintAttributes * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintAttributes { /** * Copies of document list. * @type { ?number } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ copyNumber?: number; @@ -256,7 +276,8 @@ declare namespace print { * Range size to be printed. * @type { ?PrintPageRange } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pageRange?: PrintPageRange; @@ -264,7 +285,8 @@ declare namespace print { * Page size. * @type { ?(PrintPageSize | PrintPageType) } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pageSize?: PrintPageSize | PrintPageType; @@ -272,7 +294,8 @@ declare namespace print { * Print direction. * @type { ?PrintDirectionMode } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ directionMode?: PrintDirectionMode; @@ -280,7 +303,8 @@ declare namespace print { * Color mode. * @type { ?PrintColorMode } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ colorMode?: PrintColorMode; @@ -288,7 +312,8 @@ declare namespace print { * Duplex mode. * @type { ?PrintDuplexMode } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duplexMode?: PrintDuplexMode; } @@ -297,14 +322,16 @@ declare namespace print { * defines print page range. * @typedef PrintPageRange * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintPageRange { /** * Start page of sequence. * @type { ?number } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ startPage?: number; @@ -312,7 +339,8 @@ declare namespace print { * End page of sequence. * @type { ?number } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ endPage?: number; @@ -320,7 +348,8 @@ declare namespace print { * Discrete page of sequence. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ pages?: Array; } @@ -330,7 +359,8 @@ declare namespace print { * @typedef PrintMargin * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintMargin { /** @@ -338,7 +368,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ top?: number; @@ -347,7 +378,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: number; @@ -356,7 +388,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ left?: number; @@ -365,7 +398,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ right?: number; } @@ -375,7 +409,8 @@ declare namespace print { * @typedef PrinterRange * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrinterRange { /** @@ -383,7 +418,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ startPage?: number; @@ -392,7 +428,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ endPage?: number; @@ -401,7 +438,8 @@ declare namespace print { * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ pages?: Array; } @@ -411,7 +449,8 @@ declare namespace print { * @typedef PreviewAttribute * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PreviewAttribute { /** @@ -419,7 +458,8 @@ declare namespace print { * @type { PrinterRange } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ previewRange: PrinterRange; @@ -428,7 +468,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ result?: number; } @@ -438,7 +479,8 @@ declare namespace print { * @typedef PrintResolution * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintResolution { /** @@ -446,7 +488,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ id: string; @@ -455,7 +498,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ horizontalDpi: number; @@ -464,7 +508,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ verticalDpi: number; } @@ -473,14 +518,16 @@ declare namespace print { * defines print page size. * @typedef PrintPageSize * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintPageSize { /** * Page size id. * @type { string } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ id: string; @@ -488,7 +535,8 @@ declare namespace print { * Page size name. * @type { string } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ name: string; @@ -496,7 +544,8 @@ declare namespace print { * Unit: millimeter width. * @type { number } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ width: number; @@ -504,7 +553,8 @@ declare namespace print { * Unit: millimeter height. * @type { number } * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ height: number; } @@ -514,7 +564,8 @@ declare namespace print { * @typedef PrinterCapability * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrinterCapability { /** @@ -522,7 +573,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ colorMode: number; @@ -531,7 +583,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ duplexMode: number; @@ -540,7 +593,8 @@ declare namespace print { * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ pageSize: Array; @@ -549,7 +603,8 @@ declare namespace print { * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ resolution?: Array; @@ -558,7 +613,8 @@ declare namespace print { * @type { ?PrintMargin } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ minMargin?: PrintMargin; @@ -567,7 +623,8 @@ declare namespace print { * @type { ?Object } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ options?: Object; } @@ -577,7 +634,8 @@ declare namespace print { * @typedef PrinterInfo * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrinterInfo { /** @@ -585,7 +643,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ printerId: string; @@ -594,7 +653,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ printerName: string; @@ -603,7 +663,8 @@ declare namespace print { * @type { PrinterState } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ printerState: PrinterState; @@ -612,7 +673,8 @@ declare namespace print { * @type { ?number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ printerIcon?: number; @@ -621,7 +683,8 @@ declare namespace print { * @type { ?string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ description?: string; @@ -630,7 +693,8 @@ declare namespace print { * @type { ?PrinterCapability } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ capability?: PrinterCapability; @@ -639,7 +703,8 @@ declare namespace print { * @type { ?Object } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ options?: Object; } @@ -649,7 +714,8 @@ declare namespace print { * @typedef PrintJob * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrintJob { /** @@ -657,7 +723,8 @@ declare namespace print { * @type { Array } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ fdList: Array; @@ -666,7 +733,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ jobId: string; @@ -675,7 +743,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ printerId: string; @@ -684,7 +753,8 @@ declare namespace print { * @type { PrintJobState } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ jobState: PrintJobState; @@ -693,7 +763,8 @@ declare namespace print { * @type { PrintJobSubState } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ jobSubstate: PrintJobSubState; @@ -702,7 +773,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ copyNumber: number; @@ -711,7 +783,8 @@ declare namespace print { * @type { PrinterRange } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ pageRange: PrinterRange; @@ -720,7 +793,8 @@ declare namespace print { * @type { boolean } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ isSequential: boolean; @@ -729,7 +803,8 @@ declare namespace print { * @type { PrintPageSize } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ pageSize: PrintPageSize; @@ -738,7 +813,8 @@ declare namespace print { * @type { boolean } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ isLandscape: boolean; @@ -747,7 +823,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ colorMode: number; @@ -756,7 +833,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ duplexMode: number; @@ -765,7 +843,8 @@ declare namespace print { * @type { ?PrintMargin } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ margin?: PrintMargin; @@ -774,7 +853,8 @@ declare namespace print { * @type { ?PreviewAttribute } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ preview?: PreviewAttribute; @@ -783,7 +863,8 @@ declare namespace print { * @type { ?Object } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ options?: Object; } @@ -792,27 +873,31 @@ declare namespace print { * Enumeration of Print Direction Mode. * @enum { number } PrintDirectionMode * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintDirectionMode { /** * Automatically select direction. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTION_MODE_AUTO = 0, /** * Print portrait. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTION_MODE_PORTRAIT = 1, /** * Print landscape. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DIRECTION_MODE_LANDSCAPE = 2, } @@ -821,20 +906,23 @@ declare namespace print { * Enumeration of Print Color Mode. * @enum { number } PrintColorMode * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintColorMode { /** * Print monochrome. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_MODE_MONOCHROME = 0, /** * Color printing. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ COLOR_MODE_COLOR = 1, } @@ -843,27 +931,31 @@ declare namespace print { * Enumeration of Print Duplex Mode. * @enum { number } PrintDuplexMode * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintDuplexMode { /** * Single side printing. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DUPLEX_MODE_NONE = 0, /** * Long-edge flip-up duplex printing. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DUPLEX_MODE_LONG_EDGE = 1, /** * Short-edge flip-up duplex printing. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ DUPLEX_MODE_SHORT_EDGE = 2, } @@ -872,90 +964,103 @@ declare namespace print { * Enumeration of Print Page Type. * @enum { number } PrintPageType * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintPageType { /** * A3 page. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_ISO_A3 = 0, /** * A4 page. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_ISO_A4 = 1, /** * A5 page. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_ISO_A5 = 2, /** * B5 page. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_JIS_B5 = 3, /** * C5 page. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_ISO_C5 = 4, /** * DL Envelope. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_ISO_DL = 5, /** * Letter. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_LETTER = 6, /** * Legal. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_LEGAL = 7, /** * Photo 4x6. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_PHOTO_4X6 = 8, /** * Photo 5x7. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_PHOTO_5X7 = 9, /** * Envelope INT DL. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_INT_DL_ENVELOPE = 10, /** * Tabloid B. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PAGE_B_TABLOID = 11, } @@ -964,41 +1069,47 @@ declare namespace print { * Enumeration of Print Document Adapter State. * @enum { number } PrintDocumentAdapterState * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintDocumentAdapterState { /** * Preview failed. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PREVIEW_DESTROY = 0, /** * Print state is succeed. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_TASK_SUCCEED = 1, /** * Print state is fail. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_TASK_FAIL = 2, /** * Print state is cancel. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_TASK_CANCEL = 3, /** * Print state is block. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_TASK_BLOCK = 4, } @@ -1007,27 +1118,31 @@ declare namespace print { * Enumeration of Print File Creation State. * @enum { number } PrintFileCreationState * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintFileCreationState { /** * Print file created success. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_FILE_CREATED = 0, /** * Print file created fail. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_FILE_CREATION_FAILED = 1, /** * Print file created success but unrendered. * @syscap SystemCapability.Print.PrintFramework - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_FILE_CREATED_UNRENDERED = 2, } @@ -1036,48 +1151,55 @@ declare namespace print { * Enumeration of Printer State. * @enum { number } PrinterState * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrinterState { /** * New printers arrival. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_ADDED = 0, /** * Printer lost. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_REMOVED = 1, /** * Printer update. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_CAPABILITY_UPDATED = 2, /** * Printer has been connected. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_CONNECTED = 3, /** * Printer has been disconnected. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_DISCONNECTED = 4, /** * Printer is working. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_RUNNING = 5, } @@ -1086,41 +1208,47 @@ declare namespace print { * Enumeration of Print Job State. * @enum { number } PrintJobState * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintJobState { /** * Initial state of print job. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_PREPARE = 0, /** * Deliver print job to the printer. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_QUEUED = 1, /** * Executing print job. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_RUNNING = 2, /** * Print job has been blocked. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCKED = 3, /** * Print job completed. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED = 4, } @@ -1129,202 +1257,231 @@ declare namespace print { * Enumeration of Print Job Sub State. * @enum { number } PrintJobSubState * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintJobSubState { /** * Print job succeed. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_SUCCESS = 0, /** * Print job fail. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_FAILED = 1, /** * Print job has been cancelled. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_CANCELLED = 2, /** * Print job has been corrupted. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_COMPLETED_FILE_CORRUPTED = 3, /** * Print is offline. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OFFLINE = 4, /** * Print is occupied by other process. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_BUSY = 5, /** * Print job has been cancelled. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_CANCELLED = 6, /** * Print out of paper. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OUT_OF_PAPER = 7, /** * Print out of ink. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OUT_OF_INK = 8, /** * Print out of toner. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_OUT_OF_TONER = 9, /** * Print paper jam. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_JAMMED = 10, /** * Print cover open. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_DOOR_OPEN = 11, /** * Print service request. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_SERVICE_REQUEST = 12, /** * Print low on ink. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_LOW_ON_INK = 13, /** * Print low on toner. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_LOW_ON_TONER = 14, /** * Print really low on ink. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_REALLY_LOW_ON_INK = 15, /** * Print bad certification. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_BAD_CERTIFICATE = 16, /** * Print an error occurred when printing the account. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_ACCOUNT_ERROR = 18, /** * Print the printing permission is abnormal. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_PRINT_PERMISSION_ERROR = 19, /** * Print color printing permission exception. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_PRINT_COLOR_PERMISSION_ERROR = 20, /** * Print the device is not connected to the network. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_NETWORK_ERROR = 21, /** * Print unable to connect to the server. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_SERVER_CONNECTION_ERROR = 22, /** * Print large file exception. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_LARGE_FILE_ERROR = 23, /** * Print file parsing exception. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_FILE_PARSING_ERROR = 24, /** * Print the file conversion is too slow. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_SLOW_FILE_CONVERSION = 25, /** * Print uploading file. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_RUNNING_UPLOADING_FILES = 26, /** * Print converting files. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_RUNNING_CONVERTING_FILES = 27, /** * Print unknown issue. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINT_JOB_BLOCK_UNKNOWN = 99, } @@ -1333,76 +1490,87 @@ declare namespace print { * Enumeration of Print error Code. * @enum { number } PrintErrorCode * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintErrorCode { /** * No error. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_NONE = 0, /** * No permission. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_NO_PERMISSION = 201, /** * Invalid parameter. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_INVALID_PARAMETER = 401, /** * Generic failure of print. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_GENERIC_FAILURE = 13100001, /** * RPC failure. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_RPC_FAILURE = 13100002, /** * Failure of print service. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_SERVER_FAILURE = 13100003, /** * Invalid print extension. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_INVALID_EXTENSION = 13100004, /** * Invalid printer. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_INVALID_PRINTER = 13100005, /** * Invalid print job. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_INVALID_PRINT_JOB = 13100006, /** * File i/o error. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ E_PRINT_FILE_IO = 13100007, } @@ -1411,27 +1579,31 @@ declare namespace print { * Enumeration of application event. * @enum { number } ApplicationEvent * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum ApplicationEvent { /** * Application created. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ APPLICATION_CREATED = 0, /** * Application closed for printing started. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ APPLICATION_CLOSED_FOR_STARTED = 1, /** * Application closed for printing canceled. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ APPLICATION_CLOSED_FOR_CANCELED = 2, } @@ -1441,7 +1613,8 @@ declare namespace print { * @typedef PrinterExtensionInfo * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrinterExtensionInfo { /** @@ -1449,7 +1622,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ extensionId: string; @@ -1458,7 +1632,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ vendorId: string; @@ -1467,7 +1642,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ vendorName: string; @@ -1476,7 +1652,8 @@ declare namespace print { * @type { number } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ vendorIcon: number; @@ -1485,7 +1662,8 @@ declare namespace print { * @type { string } * @syscap SystemCapability.Print.PrintFramework * @systemapi - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ version: string; } @@ -1498,7 +1676,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function queryAllPrinterExtensionInfos(callback: AsyncCallback>): void; @@ -1510,7 +1689,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function queryAllPrinterExtensionInfos(): Promise>; @@ -1525,7 +1705,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function startDiscoverPrinter(extensionList: Array, callback: AsyncCallback): void; @@ -1540,7 +1721,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function startDiscoverPrinter(extensionList: Array): Promise; @@ -1552,7 +1734,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function stopDiscoverPrinter(callback: AsyncCallback): void; @@ -1564,7 +1747,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function stopDiscoverPrinter(): Promise; @@ -1578,7 +1762,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function connectPrinter(printerId: string, callback: AsyncCallback): void; @@ -1592,7 +1777,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function connectPrinter(printerId: string): Promise; @@ -1606,7 +1792,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function disconnectPrinter(printerId: string, callback: AsyncCallback): void; @@ -1620,7 +1807,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function disconnectPrinter(printerId: string): Promise; @@ -1634,7 +1822,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function queryPrinterCapability(printerId: string, callback: AsyncCallback): void; @@ -1648,7 +1837,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function queryPrinterCapability(printerId: string): Promise; @@ -1662,7 +1852,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function startPrintJob(jobInfo: PrintJob, callback: AsyncCallback): void; @@ -1676,7 +1867,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function startPrintJob(jobInfo: PrintJob): Promise; @@ -1690,7 +1882,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function cancelPrintJob(jobId: string, callback: AsyncCallback): void; @@ -1704,7 +1897,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function cancelPrintJob(jobId: string): Promise; @@ -1718,7 +1912,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function requestPrintPreview(jobInfo: PrintJob, callback: Callback): void; @@ -1732,7 +1927,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function requestPrintPreview(jobInfo: PrintJob): Promise; @@ -1746,7 +1942,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'printerStateChange', callback: (state: PrinterState, info: PrinterInfo) => void): void; @@ -1760,7 +1957,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'printerStateChange', callback?: Callback): void; @@ -1774,7 +1972,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'jobStateChange', callback: (state: PrintJobState, job: PrintJob) => void): void; @@ -1788,7 +1987,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'jobStateChange', callback?: Callback): void; @@ -1802,7 +2002,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function on(type: 'extInfoChange', callback: (extensionId: string, info: string) => void): void; @@ -1816,7 +2017,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function off(type: 'extInfoChange', callback?: Callback): void; @@ -1830,7 +2032,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function addPrinters(printers: Array, callback: AsyncCallback): void; @@ -1844,7 +2047,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function addPrinters(printers: Array): Promise; @@ -1858,7 +2062,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function removePrinters(printerIds: Array, callback: AsyncCallback): void; @@ -1872,7 +2077,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function removePrinters(printerIds: Array): Promise; @@ -1886,7 +2092,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrinters(printers: Array, callback: AsyncCallback): void; @@ -1900,7 +2107,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrinters(printers: Array): Promise; @@ -1915,7 +2123,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrinterState(printerId: string, state: PrinterState, callback: AsyncCallback): void; @@ -1930,7 +2139,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrinterState(printerId: string, state: PrinterState): Promise; @@ -1946,7 +2156,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrintJobState(jobId: string, state: PrintJobState, subState: PrintJobSubState, callback: AsyncCallback): void; @@ -1962,7 +2173,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrintJobState(jobId: string, state: PrintJobState, subState: PrintJobSubState): Promise; @@ -1976,7 +2188,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updateExtensionInfo(info: string, callback: AsyncCallback): void; @@ -1990,7 +2203,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 */ function updateExtensionInfo(info: string): Promise; @@ -2002,7 +2216,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 11 * @useinstead print#queryPrintJobList */ @@ -2016,7 +2231,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 10 + * @since arkts {'1.1':'10','1.2':'20'} + * @arkts 1.1&1.2 * @deprecated since 11 * @useinstead print#queryPrintJobList */ @@ -2030,7 +2246,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function queryPrintJobList(callback: AsyncCallback>): void; @@ -2042,7 +2259,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function queryPrintJobList(): Promise>; @@ -2056,7 +2274,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function queryPrintJobById(jobId: string, callback: AsyncCallback): void; @@ -2070,7 +2289,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function queryPrintJobById(jobId: string): Promise; @@ -2086,7 +2306,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function startGettingPrintFile(jobId: string, printAttributes: PrintAttributes, fd: number, onFileStateChanged: Callback): void; @@ -2102,7 +2323,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyPrintService(jobId: string, type: 'spooler_closed_for_cancelled' | 'spooler_closed_for_started', callback: AsyncCallback): void; @@ -2117,7 +2339,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyPrintService(jobId: string, type: 'spooler_closed_for_cancelled' | 'spooler_closed_for_started'): Promise; @@ -2129,7 +2352,8 @@ declare namespace print { * @throws { BusinessError } 202 - not system application * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getAddedPrinters(): Promise>; @@ -2143,7 +2367,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function getPrinterInfoById(printerId: string): Promise; @@ -2157,7 +2382,8 @@ declare namespace print { * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework * @systemapi Hide this for inner system use. - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ function notifyPrintServiceEvent(event: ApplicationEvent): Promise; @@ -2169,7 +2395,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ function addPrinterToDiscovery(printerInformation: PrinterInformation): Promise; @@ -2181,7 +2408,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ function updatePrinterInDiscovery(printerInformation: PrinterInformation): Promise; @@ -2193,7 +2421,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ function removePrinterFromDiscovery(printerId: string): Promise; @@ -2205,7 +2434,8 @@ declare namespace print { * @throws { BusinessError } 201 - the application does not have permission to call this function. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ function getPrinterInformationById(printerId: string): Promise; @@ -2213,14 +2443,16 @@ declare namespace print { * defines printer information. * @typedef PrinterInformation * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrinterInformation { /** * Printer id. * @type { string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ printerId: string; @@ -2228,7 +2460,8 @@ declare namespace print { * Printer name. * @type { string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ printerName: string; @@ -2236,7 +2469,8 @@ declare namespace print { * Current printer status. * @type { PrinterStatus } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ printerStatus: PrinterStatus; @@ -2244,7 +2478,8 @@ declare namespace print { * Printer description. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ description?: string; @@ -2252,7 +2487,8 @@ declare namespace print { * Printer capabilities. * @type { ?PrinterCapabilities } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ capability?: PrinterCapabilities; @@ -2260,7 +2496,8 @@ declare namespace print { * Printer uri. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ uri?: string; @@ -2268,7 +2505,8 @@ declare namespace print { * Printer make. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ printerMake?: string; @@ -2276,7 +2514,8 @@ declare namespace print { * Detail information in json format. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ options?: string; } @@ -2285,14 +2524,16 @@ declare namespace print { * defines printer capabilities. * @typedef PrinterCapabilities * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ interface PrinterCapabilities { /** * The page size list supported by the printer. * @type { Array } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ supportedPageSizes: Array; @@ -2300,7 +2541,8 @@ declare namespace print { * Array of supported color mode. * @type { Array } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ supportedColorModes: Array; @@ -2308,7 +2550,8 @@ declare namespace print { * Array of supported duplex mode. * @type { Array } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ supportedDuplexModes: Array; @@ -2316,7 +2559,8 @@ declare namespace print { * Array of supported print media types. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ supportedMediaTypes?: Array; @@ -2324,7 +2568,8 @@ declare namespace print { * Array of supported print quality. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ supportedQualities?: Array; @@ -2332,7 +2577,8 @@ declare namespace print { * Array of supported print orientation. * @type { ?Array } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ supportedOrientations?: Array; @@ -2340,7 +2586,8 @@ declare namespace print { * Advanced capability in json format. * @type { ?string } * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ options?: string; } @@ -2349,27 +2596,31 @@ declare namespace print { * Enumeration of Print Quality. * @enum { number } PrintQuality * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintQuality { /** * Draft quality mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_DRAFT = 3, /** * Normal quality mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_NORMAL = 4, /** * High quality mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ QUALITY_HIGH = 5, } @@ -2378,41 +2629,47 @@ declare namespace print { * Enumeration of Print OrientationMode. * @enum { number } PrintOrientationMode * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrintOrientationMode { /** * Portrait mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION_MODE_PORTRAIT = 0, /** * Landscape mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION_MODE_LANDSCAPE= 1, /** * Reverse landscape mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION_MODE_REVERSE_LANDSCAPE = 2, /** * Reverse portrait mode. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION_MODE_REVERSE_PORTRAIT = 3, /** * Not specified. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ ORIENTATION_MODE_NONE = 4, } @@ -2421,27 +2678,31 @@ declare namespace print { * Enumeration of Printer Status. * @enum { number } PrinterStatus * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enum PrinterStatus { /** * Printer idle. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_IDLE = 0, /** * Printer busy. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_BUSY = 1, /** * Printer not available. * @syscap SystemCapability.Print.PrintFramework - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ PRINTER_UNAVAILABLE = 2, } diff --git a/api/@ohos.privacyManager.d.ts b/api/@ohos.privacyManager.d.ts index fe192c0af42fceb2251aa333ca4fe0102b55842f..43e9ff36d0b2620a38feea9387e5ca8da5ff75dd 100644 --- a/api/@ohos.privacyManager.d.ts +++ b/api/@ohos.privacyManager.d.ts @@ -20,21 +20,25 @@ import { AsyncCallback, Callback } from './@ohos.base'; import { Permissions } from './permissions'; +/*** if arkts 1.1 */ +import { int } from '@ohos.base'; +/*** endif */ /** * @namespace privacyManager * @syscap SystemCapability.Security.AccessToken - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace privacyManager { /** * Adds access record of sensitive permission. * * @permission ohos.permission.PERMISSION_USED_STATS - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be added. - * @param { number } successCount - Access count. - * @param { number } failCount - Reject count. + * @param { int } successCount - Access count. + * @param { int } failCount - Reject count. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". @@ -52,10 +56,10 @@ declare namespace privacyManager { * Adds an access record of a sensitive permission. * * @permission ohos.permission.PERMISSION_USED_STATS - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission accessed. - * @param { number } successCount - Number of successful accesses to the permission. - * @param { number } failCount - Number of failed accesses to the permission. + * @param { int } successCount - Number of successful accesses to the permission. + * @param { int } failCount - Number of failed accesses to the permission. * @param { AddPermissionUsedRecordOptions } options - Options to be added. * @returns { Promise } Promise that returns no value. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. @@ -69,13 +73,14 @@ declare namespace privacyManager { * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ function addPermissionUsedRecord( - tokenID: number, + tokenID: int, permissionName: Permissions, - successCount: number, - failCount: number, + successCount: int, + failCount: int, options?: AddPermissionUsedRecordOptions ): Promise; @@ -83,10 +88,10 @@ declare namespace privacyManager { * Adds access record of sensitive permission. * * @permission ohos.permission.PERMISSION_USED_STATS - * @param { number } tokenID - Token ID of the application. + * @param { int } tokenID - Token ID of the application. * @param { Permissions } permissionName - Name of the permission to be added. - * @param { number } successCount - Access count. - * @param { number } failCount - Reject count. + * @param { int } successCount - Access count. + * @param { int } failCount - Reject count. * @param { AsyncCallback } callback - Asynchronous callback interface. * @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified; 2.Incorrect parameter types. * @throws { BusinessError } 201 - Permission denied. Interface caller does not have permission "ohos.permission.PERMISSION_USED_STATS". @@ -98,13 +103,14 @@ declare namespace privacyManager { * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function addPermissionUsedRecord( - tokenID: number, + tokenID: int, permissionName: Permissions, - successCount: number, - failCount: number, + successCount: int, + failCount: int, callback: AsyncCallback ): void; @@ -315,7 +321,8 @@ declare namespace privacyManager { * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function on( type: 'activeStateChange', @@ -339,7 +346,8 @@ declare namespace privacyManager { * @throws { BusinessError } 12100008 - Out of memory. * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ function off( type: 'activeStateChange', @@ -400,10 +408,11 @@ declare namespace privacyManager { /** * Enum for permission for status. * - * @enum { number } PermissionActiveStatus + * @enum { int } PermissionActiveStatus * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PermissionActiveStatus { /** @@ -411,7 +420,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PERM_INACTIVE = 0, @@ -420,7 +430,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PERM_ACTIVE_IN_FOREGROUND = 1, @@ -429,7 +440,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ PERM_ACTIVE_IN_BACKGROUND = 2 } @@ -440,28 +452,31 @@ declare namespace privacyManager { * @interface ActiveChangeResponse * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface ActiveChangeResponse { /** * AccessTokenID which called the interface * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ - callingTokenId?: number; + callingTokenId?: int; /** * AccessTokenID * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - tokenId: number; + tokenId: int; /** * The permission name @@ -469,7 +484,8 @@ declare namespace privacyManager { * @type { Permissions } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ permissionName: Permissions; @@ -479,7 +495,8 @@ declare namespace privacyManager { * @type { string } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; @@ -489,7 +506,8 @@ declare namespace privacyManager { * @type { PermissionActiveStatus } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ activeStatus: PermissionActiveStatus; @@ -499,7 +517,8 @@ declare namespace privacyManager { * @type { ?PermissionUsedType } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 18 + * @since arkts {'1.1':'18', '1.2':'20'} + * @arkts 1.1&1.2 */ usedType?: PermissionUsedType; } @@ -507,10 +526,11 @@ declare namespace privacyManager { /** * PermissionUsageFlag. * - * @enum { number } PermissionUsageFlag + * @enum { int } PermissionUsageFlag * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PermissionUsageFlag { /** @@ -518,7 +538,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_PERMISSION_USAGE_SUMMARY = 0, /** @@ -526,7 +547,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ FLAG_PERMISSION_USAGE_DETAIL = 1 } @@ -537,18 +559,20 @@ declare namespace privacyManager { * @interface PermissionUsedRequest * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PermissionUsedRequest { /** * AccessTokenID * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - tokenId?: number; + tokenId?: int; /** * Distribute flag @@ -557,7 +581,8 @@ declare namespace privacyManager { * @default false * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isRemote?: boolean; @@ -567,7 +592,8 @@ declare namespace privacyManager { * @type { ?string } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deviceId?: string; @@ -577,7 +603,8 @@ declare namespace privacyManager { * @type { ?string } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName?: string; @@ -587,31 +614,34 @@ declare namespace privacyManager { * @type { ?Array } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ permissionNames?: Array; /** * The begin time, in milliseconds * - * @type { ?number } + * @type { ?int } * @default 0 * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - beginTime?: number; + beginTime?: int; /** * The end time, in milliseconds * - * @type { ?number } + * @type { ?int } * @default 0 * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - endTime?: number; + endTime?: int; /** * The permission usage flag @@ -619,7 +649,8 @@ declare namespace privacyManager { * @type { PermissionUsageFlag } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ flag: PermissionUsageFlag; } @@ -630,28 +661,31 @@ declare namespace privacyManager { * @interface PermissionUsedResponse * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PermissionUsedResponse { /** * The begin time, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - beginTime: number; + beginTime: int; /** * The end time, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - endTime: number; + endTime: int; /** * The list of permission used records of bundle @@ -659,7 +693,8 @@ declare namespace privacyManager { * @type { Array } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleRecords: Array; } @@ -670,18 +705,20 @@ declare namespace privacyManager { * @interface BundleUsedRecord * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface BundleUsedRecord { /** * AccessTokenID * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - tokenId: number; + tokenId: int; /** * Distribute flag @@ -689,7 +726,8 @@ declare namespace privacyManager { * @type { boolean } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ isRemote: boolean; @@ -699,7 +737,8 @@ declare namespace privacyManager { * @type { string } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ deviceId: string; @@ -709,7 +748,8 @@ declare namespace privacyManager { * @type { string } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ bundleName: string; @@ -719,7 +759,8 @@ declare namespace privacyManager { * @type { Array } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ permissionRecords: Array; } @@ -730,7 +771,8 @@ declare namespace privacyManager { * @interface PermissionUsedRecord * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PermissionUsedRecord { /** @@ -739,59 +781,65 @@ declare namespace privacyManager { * @type { Permissions } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ permissionName: Permissions; /** * The access counts * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - accessCount: number; + accessCount: int; /** * The reject counts * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - rejectCount: number; + rejectCount: int; /** * The last access time, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - lastAccessTime: number; + lastAccessTime: int; /** * The last reject time, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - lastRejectTime: number; + lastRejectTime: int; /** * The last access duration, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - lastAccessDuration: number; + lastAccessDuration: int; /** * The list of access records of details @@ -799,7 +847,8 @@ declare namespace privacyManager { * @type { Array } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ accessRecords: Array; @@ -809,7 +858,8 @@ declare namespace privacyManager { * @type { Array } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ rejectRecords: Array; } @@ -820,58 +870,64 @@ declare namespace privacyManager { * @interface UsedRecordDetail * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ interface UsedRecordDetail { /** * The status * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - status: number; + status: int; /** * Indicates the status of lockscreen. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - lockScreenStatus?: number; + lockScreenStatus?: int; /** * Timestamp, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - timestamp: number; + timestamp: int; /** * The value of successCount or failCount passed in to addPermissionUsedRecord. * - * @type { ?number } + * @type { ?int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 11 + * @since arkts {'1.1':'11', '1.2':'20'} + * @arkts 1.1&1.2 */ - count?: number; + count?: int; /** * Access duration, in milliseconds * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 9 + * @since arkts {'1.1':'9', '1.2':'20'} + * @arkts 1.1&1.2 */ - accessDuration: number; + accessDuration: int; /** * Used type of the permission accessed. @@ -879,7 +935,8 @@ declare namespace privacyManager { * @type { ?PermissionUsedType } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ usedType?: PermissionUsedType; } @@ -887,10 +944,11 @@ declare namespace privacyManager { /** * Enumerates the means by which sensitive resources are accessed. * - * @enum { number } PermissionUsedType + * @enum { int } PermissionUsedType * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ enum PermissionUsedType { /** @@ -898,7 +956,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ NORMAL_TYPE = 0, @@ -907,7 +966,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ PICKER_TYPE = 1, @@ -916,7 +976,8 @@ declare namespace privacyManager { * * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ SECURITY_COMPONENT_TYPE = 2 } @@ -927,18 +988,20 @@ declare namespace privacyManager { * @interface PermissionUsedTypeInfo * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface PermissionUsedTypeInfo { /** * Token ID of the application. * - * @type { number } + * @type { int } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ - tokenId: number; + tokenId: int; /** * Name of the permission accessed. @@ -946,7 +1009,8 @@ declare namespace privacyManager { * @type { Permissions } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ permissionName: Permissions; @@ -956,7 +1020,8 @@ declare namespace privacyManager { * @type { PermissionUsedType } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ usedType: PermissionUsedType; } @@ -967,7 +1032,8 @@ declare namespace privacyManager { * @interface AddPermissionUsedRecordOptions * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ interface AddPermissionUsedRecordOptions { /** @@ -976,11 +1042,12 @@ declare namespace privacyManager { * @type { ?PermissionUsedType } * @syscap SystemCapability.Security.AccessToken * @systemapi - * @since 12 + * @since arkts {'1.1':'12', '1.2':'20'} + * @arkts 1.1&1.2 */ usedType?: PermissionUsedType; } } export default privacyManager; -export { Permissions }; \ No newline at end of file +export { Permissions }; diff --git a/api/@ohos.promptAction.d.ts b/api/@ohos.promptAction.d.ts index a07be30d8f91644099104719bba320177dc30eca..b70ac894f714122e5ae21a96bcaa5b08e773ca03 100644 --- a/api/@ohos.promptAction.d.ts +++ b/api/@ohos.promptAction.d.ts @@ -18,9 +18,21 @@ * @kit ArkUI */ - - +/*** if arkts 1.1 */ import { AsyncCallback } from './@ohos.base'; +/*** endif */ + +/*** if arkts 1.2 */ +import { ResourceColor, Offset, Dimension, EdgeStyles, EdgeColors,EdgeWidths, BorderRadiuses } from './arkui/component/units'; +import { AsyncCallback, Callback } from './@ohos.base'; +import { BlurStyle, ShadowOptions, ShadowStyle, HoverModeAreaType, Rectangle, TransitionEffect, KeyboardAvoidMode, DismissReason, + BackgroundBlurStyleOptions, BackgroundEffectOptions } from './arkui/component/common'; +import { CustomBuilder } from './arkui/component/builder'; +import { DialogAlignment } from './arkui/component/alertDialog'; +import { BorderStyle,Alignment } from './arkui/component/enums'; +import { Resource } from './global/resource'; +import { LengthMetrics } from './arkui/Graphics'; +/*** endif */ /** * Define the display mode of all kind of dialog @@ -29,7 +41,8 @@ import { AsyncCallback } from './@ohos.base'; * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ export enum LevelMode { /** @@ -38,7 +51,8 @@ export enum LevelMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ OVERLAY = 0, @@ -48,7 +62,8 @@ export enum LevelMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ EMBEDDED = 1, } @@ -60,7 +75,8 @@ export enum LevelMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ export enum ImmersiveMode { /** @@ -69,7 +85,8 @@ export enum ImmersiveMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -79,7 +96,8 @@ export enum ImmersiveMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 15 + * @since arkts {'1.1':'15','1.2':'20'} + * @arkts 1.1&1.2 */ EXTEND = 1, } @@ -90,9 +108,10 @@ export enum ImmersiveMode { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ -export class LevelOrder { +export declare class LevelOrder { /** * Generate valid level order. * @@ -102,9 +121,10 @@ export class LevelOrder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - static clamp(order: number): LevelOrder + static clamp(order: number): LevelOrder; /** * Get the order from LevelOrder object. @@ -113,9 +133,10 @@ export class LevelOrder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 18 + * @since arkts {'1.1':'18','1.2':'20'} + * @arkts 1.1&1.2 */ - getOrder(): number + getOrder(): number; } /** @@ -134,28 +155,36 @@ export class LevelOrder { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ declare namespace promptAction { /** + * Defines the option of show toast. + * * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** + * Defines the option of show toast. + * * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** + * Defines the option of show toast. + * * @typedef ShowToastOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - interface ShowToastOptions { + export interface ShowToastOptions { /** * Text to display. @@ -179,7 +208,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ message: string | Resource; @@ -211,7 +241,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ duration?: number; @@ -237,7 +268,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ bottom?: string | number; @@ -257,7 +289,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ showMode?: ToastShowMode; /** @@ -267,7 +300,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ alignment?: Alignment; /** @@ -277,7 +311,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ offset?: Offset; /** @@ -287,7 +322,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundColor?: ResourceColor; /** @@ -297,7 +333,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ textColor?: ResourceColor; /** @@ -307,7 +344,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ backgroundBlurStyle?: BlurStyle; /** @@ -317,7 +355,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ shadow?: ShadowOptions | ShadowStyle; @@ -329,7 +368,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ enableHoverMode?: boolean; @@ -341,7 +381,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 14 + * @since arkts {'1.1':'14','1.2':'20'} + * @arkts 1.1&1.2 */ hoverModeArea?: HoverModeAreaType; } @@ -360,7 +401,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ export enum ToastShowMode { /** @@ -375,7 +417,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ DEFAULT = 0, @@ -391,7 +434,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ TOP_MOST = 1, @@ -400,30 +444,38 @@ declare namespace promptAction { * * @syscap SystemCapability.ArkUI.ArkUI.Full * @systemapi - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ SYSTEM_TOP_MOST = 2 } /** + * Defines button in promptAction. + * * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** + * Defines button in promptAction. + * * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** + * Defines button in promptAction. + * * @typedef Button * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - interface Button { + export interface Button { /** * The text displayed in the button. @@ -447,7 +499,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ text: string | Resource; @@ -473,7 +526,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ color: string | Resource; /** @@ -483,30 +537,110 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 12 + * @since arkts {'1.1':'12','1.2':'20'} + * @arkts 1.1&1.2 */ primary?: boolean; } /** + * Defines the one-button array. + * + * @typedef { [Button] } PromptActionSingleButton + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PromptActionSingleButton = [Button]; + + /** + * Defines the two-buttons array. + * + * @typedef { [Button, Button | undefined] } PromptActionDoubleButtons + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PromptActionDoubleButtons = [Button, Button | undefined]; + + /** + * Defines the three-buttons array. + * + * @typedef { [Button, Button | undefined, Button | undefined] } PromptActionTripleButtons + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PromptActionTripleButtons = [Button, Button | undefined, Button | undefined]; + + /** + * Defines the four-buttons array. + * + * @typedef { [Button, Button | undefined, Button | undefined, Button | undefined] } PromptActionQuadrupleButtons + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PromptActionQuadrupleButtons = [Button, Button | undefined, Button | undefined, Button | undefined]; + + /** + * Defines the five-buttons array. + * + * @typedef { [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined] } PromptActionQuintupleButtons + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PromptActionQuintupleButtons = [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined]; + + /** + * Defines the six-buttons array. + * + * @typedef { [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined, Button | undefined] } PromptActionSextupleButtons + * @syscap SystemCapability.ArkUI.ArkUI.Full + * @crossplatform + * @atomicservice + * @since 20 + * @arkts 1.2 + */ + export type PromptActionSextupleButtons = [Button, Button | undefined, Button | undefined, Button | undefined, Button | undefined, Button | undefined]; + + /** + * Defines success response of show dialog. + * * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** + * Defines success response of show dialog. + * * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** + * Defines success response of show dialog. + * * @typedef ShowDialogSuccessResponse * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - interface ShowDialogSuccessResponse { + export interface ShowDialogSuccessResponse { /** * Index of the selected button, starting from 0. @@ -530,30 +664,38 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ index: number; } /** + * Defines the option of show dialog. + * * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @since 9 */ /** + * Defines the option of show dialog. + * * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @since 10 */ /** + * Defines the option of show dialog. + * * @typedef ShowDialogOptions * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ - interface ShowDialogOptions { + export interface ShowDialogOptions { /** * Title of the text to display. @@ -577,7 +719,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ title?: string | Resource; @@ -603,7 +746,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ message?: string | Resource; @@ -636,7 +780,8 @@ declare namespace promptAction { * @syscap SystemCapability.ArkUI.ArkUI.Full * @crossplatform * @atomicservice - * @since 11 + * @since arkts {'1.1':'11','1.2':'20'} + * @arkts 1.1&1.2 */ buttons?: Array