HarmonyOS API：通用能力的接口

joytrian

发布于 2023-3-31 17:52

浏览

0收藏

版本：v3.1 Beta

@ohos.ability.dataUriUtils (DataUriUtils模块)

更新时间: 2023-02-17 09:19

DataUriUtils模块提供用于处理使用DataAbilityHelper方案的对象的实用程序类的能力，包括获取，添加，更新给定uri的路径组件末尾的ID。

说明

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import dataUriUtils from '@ohos.ability.dataUriUtils';

dataUriUtils.getId

getId(uri: string): number

获取附加到给定uri的路径组件末尾的ID。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
uri	string	是	指示要从中获取ID的uri对象。

返回值：

类型	说明
number	附加到路径组件末尾的ID。

示例：

dataUriUtils.getId("com.example.dataUriUtils/1221")

dataUriUtils.attachId

attachId(uri: string, id: number): string

将给定ID附加到给定uri的路径组件的末尾。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
uri	string	是	指示要从中获取ID的uri对象。
id	number	是	指示要附加的ID。

返回值：

类型	说明
string	附加给定ID的uri对象。

示例：

var idint = 1122;
dataUriUtils.attachId(
    "com.example.dataUriUtils",
    idint,
)

dataUriUtils.deleteId

deleteId(uri: string): string

从给定uri的路径组件的末尾删除ID。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
uri	string	是	指示要从中删除ID的uri对象。

返回值：

类型	说明
string	ID已删除的uri对象。

示例：

dataUriUtils.deleteId("com.example.dataUriUtils/1221")

dataUriUtils.updateId

updateId(uri: string, id: number): string

更新指定uri中的ID。

系统能力：SystemCapability.Ability.AbilityRuntime.Core

参数：

参数名	类型	必填	说明
uri	string	是	指示要更新的uri对象
id	number	是	指示新ID

返回值：

类型	说明
string	更新的uri对象。

示例：

var idint = 1122;
dataUriUtils.updateId(
    "com.example.dataUriUtils",
    idint
)

@ohos.ability.errorCode (ErrorCode)

更新时间: 2023-02-17 09:19

ErrorCode是定义启动功能时使用的错误代码。

本模块提供使用的错误代码的能力，包括没有错误，无效的参数等。

说明

本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import errorCode from '@ohos.ability.errorCode'

ErrorCode

定义启动功能时使用的错误代码。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core

名称	值	说明
NO_ERROR	0	没有错误。
INVALID_PARAMETER	-1	无效的参数。
ABILITY_NOT_FOUND	-2	找不到ABILITY。
PERMISSION_DENY	-3	拒绝许可。

@ohos.ability.wantConstant (wantConstant)

更新时间: 2023-02-17 09:19

wantConstant模块提供want中操作want常数和解释Flags说明的能力。

说明

本模块首批接口从API version 6开始支持，从API version 9废弃，替换模块为@ohos.app.ability.wantConstant。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import wantConstant from '@ohos.ability.wantConstant';

wantConstant.Action

want操作的常数。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	值	说明
ACTION_HOME	ohos.want.action.home	指示返回原点的操作。
ACTION_DIAL	ohos.want.action.dial	指示启动显示小键盘的页面功能的操作
ACTION_SEARCH	ohos.want.action.search	指示启动页面搜索功能的操作。
ACTION_WIRELESS_SETTINGS	ohos.settings.wireless	指示启动提供无线网络设置的页面功能的操作，例如，Wi-Fi选项。
ACTION_MANAGE_APPLICATIONS_SETTINGS	ohos.settings.manage.applications	指示启动管理已安装应用程序的页面功能的操作。
ACTION_APPLICATION_DETAILS_SETTINGS	ohos.settings.application.details	指示启动显示指定应用程序详细信息的页面功能的操作。
ACTION_SET_ALARM	ohos.want.action.setAlarm	指示启动页面功能以设置闹钟的操作。
ACTION_SHOW_ALARMS	ohos.want.action.showAlarms	指示启动显示所有警报的页面功能的操作时钟。
ACTION_SNOOZE_ALARM	ohos.want.action.snoozeAlarm	指示启动用于使闹钟睡眠的页面功能的操作。
ACTION_DISMISS_ALARM	ohos.want.action.dismissAlarm	指示启动删除闹钟的页面功能的操作。
ACTION_DISMISS_TIMER	ohos.want.action.dismissTimer	指示启动页面功能以关闭计时器的操作。
ACTION_SEND_SMS	ohos.want.action.sendSms	指示启动发送sms的页面功能的操作。
ACTION_CHOOSE	ohos.want.action.choose	指示启动页面功能以打开联系人或图片的操作。
ACTION_IMAGE_CAPTURE⁸⁺	ohos.want.action.imageCapture	指示启动页面拍照功能的操作。
ACTION_VIDEO_CAPTURE⁸⁺	ohos.want.action.videoCapture	指示启动页面功能以拍摄视频的操作。
ACTION_SELECT	ohos.want.action.select	指示显示应用程序选择对话框的操作。
ACTION_SEND_DATA	ohos.want.action.sendData	指示发送单个数据记录的操作。
ACTION_SEND_MULTIPLE_DATA	ohos.want.action.sendMultipleData	指示发送多个数据记录的操作。
ACTION_SCAN_MEDIA_FILE	ohos.want.action.scanMediaFile	指示请求媒体扫描仪扫描文件并将文件添加到媒体库的操作。
ACTION_VIEW_DATA	ohos.want.action.viewData	指示查看数据的操作。
ACTION_EDIT_DATA	ohos.want.action.editData	指示编辑数据的操作。
INTENT_PARAMS_INTENT	ability.want.params.INTENT	指示用行为选择器来展示选择的操作。
INTENT_PARAMS_TITLE	ability.want.params.TITLE	指示与行为选择器一起使用时的字符序列对话框标题。
ACTION_FILE_SELECT⁷⁺	ohos.action.fileSelect	指示选择文件的操作。
PARAMS_STREAM⁷⁺	ability.params.stream	指示发送数据时与目标关联的数据流的URI
ACTION_APP_ACCOUNT_OAUTH ⁸⁺	ohos.account.appAccount.action.oauth	指示提供oauth服务的操作。
ACTION_APP_ACCOUNT_AUTH ⁹⁺	account.appAccount.action.auth	指示提供auth服务的操作。

wantConstant.Entity

want实体的常数。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	值	说明
ENTITY_DEFAULT	entity.system.default	指示默认实体，如果未指定该实体，则使用该实体。
ENTITY_HOME	entity.system.home	指示主屏幕实体。
ENTITY_VOICE	entity.system.voice	表示语音交互实体。
ENTITY_BROWSABLE	entity.system.browsable	指示浏览器类别。
ENTITY_VIDEO	entity.system.video	指示视频类别。

wantConstant.Flags

Flags说明。

系统能力：以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase

名称	值	说明
FLAG_AUTH_READ_URI_PERMISSION	0x00000001	指示对URI执行读取操作的授权。
FLAG_AUTH_WRITE_URI_PERMISSION	0x00000002	指示对URI执行写入操作的授权。
FLAG_ABILITY_FORWARD_RESULT	0x00000004	将结果返回给元能力。
FLAG_ABILITY_CONTINUATION	0x00000008	确定是否可以将本地设备上的功能迁移到远程设备。
FLAG_NOT_OHOS_COMPONENT	0x00000010	指定组件是否属于OHOS。
FLAG_ABILITY_FORM_ENABLED	0x00000020	指定是否启动某个能力。
FLAG_ABILITYSLICE_MULTI_DEVICE	0x00000100	支持分布式调度系统中的多设备启动。
FLAG_START_FOREGROUND_ABILITY	0x00000200	指示无论主机应用程序是否已启动，都将启动使用服务模板的功能。
FLAG_INSTALL_ON_DEMAND	0x00000800	如果未安装指定的功能，请安装该功能。
FLAG_INSTALL_WITH_BACKGROUND_MODE	0x80000000	如果未安装，使用后台模式安装该功能。
FLAG_ABILITY_CLEAR_MISSION	0x00008000	指示清除其他任务的操作。可以为传递给startAbility方法的Want设置此标志，并且必须与flag_ABILITY_NEW_MISSION一起使用。
FLAG_ABILITY_NEW_MISSION	0x10000000	指示在历史任务堆栈上创建任务的操作。
FLAG_ABILITY_MISSION_TOP	0x20000000	指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。