Context

The Context module provides context for abilities or applications. It allows access to application-specific resources.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. The APIs of this module can be used only in the stage model.

Modules to Import

import common from '@ohos.app.ability.common';

Attributes

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Type	Readable	Writable	Description
resourceManager	resmgr.ResourceManager	Yes	No	Object for resource management.
applicationInfo	ApplicationInfo	Yes	No	Application information.
cacheDir	string	Yes	No	Cache directory.
tempDir	string	Yes	No	Temporary directory.
filesDir	string	Yes	No	File directory.
databaseDir	string	Yes	No	Database directory.
preferencesDir	string	Yes	No	Preferences directory.
bundleCodeDir	string	Yes	No	Bundle code directory. Do not access resource files by concatenating paths. Use the resourceManager API instead.
distributedFilesDir	string	Yes	No	Distributed file directory.
eventHub	EventHub	Yes	No	Event hub that implements event subscription, unsubscription, and triggering.
area	AreaMode	Yes	No	Area in which the file to be access is located.

Context.createBundleContext

createBundleContext(bundleName: string): Context;

Creates the context based on the bundle name.

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name.

Return value

Type	Description
Context	Context created.

Example

let bundleContext: common.Context;
try {
    bundleContext = this.context.createBundleContext('com.example.test');
} catch (error) {
    console.error('createBundleContext failed, error.code: ${error.code}, error.message: ${error.message}');
}

Context.createModuleContext

createModuleContext(moduleName: string): Context;

Creates the context based on the module name.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
moduleName	string	Yes	Module name.

Return value

Type	Description
Context	Context created.

Example

let moduleContext: common.Context;
try {
    moduleContext = this.context.createModuleContext('entry');
} catch (error) {
    console.error('createModuleContext failed, error.code: ${error.code}, error.message: ${error.message}');
}

Context.createModuleContext

createModuleContext(bundleName: string, moduleName: string): Context;

Creates the context based on the bundle name and module name.

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API and cannot be called by third-party applications.

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name.
moduleName	string	Yes	Module name.

Return value

Type	Description
Context	Context created.

Example

let moduleContext: common.Context;
try {
    moduleContext = this.context.createModuleContext('com.example.test', 'entry');
} catch (error) {
    console.error('createModuleContext failed, error.code: ${error.code}, error.message: ${error.message}');
}

Context.getApplicationContext

getApplicationContext(): ApplicationContext;

Obtains the application context.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Context	Application context obtained.

Example

let applicationContext: common.Context;
try {
    applicationContext = this.context.getApplicationContext();
} catch (error) {
    console.error('getApplicationContext failed, error.code: ${error.code}, error.message: ${error.message}');
}

AreaMode

Enumerates the encryption levels of directories.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Value	Description
EL1	0	Device-level encryption. Directories with this encryption level are accessible after the device is powered on.
EL2	1	User-level encryption. Directories with this encryption level are accessible only after the device is powered on and the password is entered (for the first time).