鸿蒙5.0开发进阶:ArkTS API-Context

往期鸿蒙全套实战文章必看:(文中附带全栈鸿蒙学习资料)


Context

Context模块继承自BaseContext,提供了ability或application的上下文的能力,包括访问特定应用程序的资源等。

说明

  • 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
  • 本模块接口仅可在Stage模型下使用。

导入模块

import { common } from '@kit.AbilityKit';

属性

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

名称类型只读可选说明
resourceManagerresmgr.ResourceManager

资源管理对象。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

applicationInfoApplicationInfo

当前应用程序的信息。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

cacheDirstring

缓存目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

tempDirstring

临时目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

resourceDir11+string

资源目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

filesDirstring

文件目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

databaseDirstring

数据库目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

preferencesDirstring

preferences目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

bundleCodeDirstring

安装包目录。不能拼接路径访问资源文件,请使用资源管理接口访问资源。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

distributedFilesDirstring

分布式文件目录。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

cloudFileDir12+string

云文件目录。

元服务API: 从API version 12开始,该接口支持在元服务中使用。

eventHubEventHub

事件中心,提供订阅、取消订阅、触发事件对象。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

areacontextConstant.AreaMode

文件分区信息。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

Context.createModuleContext(deprecated)

createModuleContext(moduleName: string): Context

根据模块名创建上下文。

说明

从 API Version 12 开始废弃,建议使用application.createModuleContext替代。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

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

参数:

参数名类型必填说明
moduleNamestring模块名。

返回值:

类型说明
Context模块的上下文。

错误码

以下错误码详细介绍。

错误码ID错误信息
401Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

示例:

import { common, UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  onCreate() {
    console.log('MyAbility onCreate');
    let moduleContext: common.Context;
    try {
      moduleContext = this.context.createModuleContext('entry');
    } catch (error) {
      console.error(`createModuleContext failed, error.code: ${(error as BusinessError).code}, error.message: ${(error as BusinessError).message}`);
    }
  }
}

说明:仅支持获取本应用中其他Module的Context和应用内HSP的Context,不支持获取其他应用的Context。

Context.getApplicationContext

getApplicationContext(): ApplicationContext

获取本应用的应用上下文。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

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

返回值:

类型说明
ApplicationContext应用上下文Context。

错误码

以下错误码详细介绍。

错误码ID错误信息
401Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.

示例:

import { common, UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  onCreate() {
    console.log('MyAbility onCreate');
    let applicationContext: common.Context;
    try {
      applicationContext = this.context.getApplicationContext();
    } catch (error) {
      console.error(`getApplicationContext failed, error.code: ${(error as BusinessError).code}, error.message: ${(error as BusinessError).message}`);
    }
  }
}

Context.getGroupDir10+

getGroupDir(dataGroupID: string): Promise<string>

通过使用应用中的Group ID获取对应的共享目录,使用Promise异步回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

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

参数:

参数名类型必填说明
dataGroupIDstring元服务应用项目创建时,系统会指定分配唯一Group ID。

返回值:

类型说明
Promise<string>以Promise方式返回对应的共享目录。如果不存在则返回为空,仅支持应用el2加密级别。

错误码:

以下错误码详细介绍。

错误码ID错误信息
401Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
16000011The context does not exist.

示例:

import { common, UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  onCreate() {
    console.log('MyAbility onCreate');
    let groupId = "1";
    let getGroupDirContext: common.Context = this.context;
    try {
      getGroupDirContext.getGroupDir(groupId).then(data => {
        console.log("getGroupDir result:" + data);
      })
    } catch (error) {
      console.error(`getGroupDirContext failed, error.code: ${(error as BusinessError).code}, error.message: ${(error as BusinessError).message}`);
    }
  }
}

Context.getGroupDir10+

getGroupDir(dataGroupID: string, callback: AsyncCallback<string>): void

通过使用应用中的Group ID获取对应的共享目录,使用callback异步回调。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

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

参数:

参数名类型必填说明
dataGroupIDstring元服务应用项目创建时,系统会指定分配唯一Group ID。
callbackAsyncCallback<string>以callback方式返回对应的共享目录。如果不存在则返回为空,仅支持应用el2加密级别。

错误码:

以下错误码详细介绍。

错误码ID错误信息
401Parameter error. Possible causes: 1.Mandatory parameters are left unspecified. 2.Incorrect parameter types.
16000011The context does not exist.

示例:

import { common, UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

export default class EntryAbility extends UIAbility {
  onCreate() {
    console.log('MyAbility onCreate');
    let getGroupDirContext: common.Context = this.context;

    getGroupDirContext.getGroupDir("1", (err: BusinessError, data) => {
      if (err) {
        console.error(`getGroupDir faile, err: ${JSON.stringify(err)}`);
      } else {
        console.log(`getGroupDir result is: ${JSON.stringify(data)}`);
      }
    });
  }
}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值