harmony 鸿蒙Context

2022-12-22
浏览 (544)

Context

The Context module provides context for abilities or applications. It allows access to application-specific resources, as well as permission requests and verification.

NOTE

The initial APIs of this module are supported since API version 6. 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 FA model.

Modules to Import

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

Usage

The Context object is created in a featureAbility and returned through its getContext API. Therefore, you must import the @ohos.ability.featureAbility package before using the Context module. An example is as follows:

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getOrCreateLocalDir().then((data) => {
    console.info(`getOrCreateLocalDir data: ${JSON.stringify(data)}`);
});

Context.getOrCreateLocalDir⁷⁺

getOrCreateLocalDir(callback: AsyncCallback<string>): void

Obtains the local root directory of the application. This API uses an asynchronous callback to return the result.

If this API is called for the first time, a root directory will be created.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the local root directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getOrCreateLocalDir((error, data)=>{
    if (error && error.code !== 0) {
        console.error(`getOrCreateLocalDir fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getOrCreateLocalDir success, data: ${JSON.stringify(data)}`);
    }
});

Context.getOrCreateLocalDir⁷⁺

getOrCreateLocalDir(): Promise<string>

Obtains the local root directory of the application. This API uses a promise to return the result.

If this API is called for the first time, a root directory will be created.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the local root directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getOrCreateLocalDir().then((data) => {
    console.info(`getOrCreateLocalDir data: ${JSON.stringify(data)}`);
});

Context.verifyPermission⁷⁺

verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback<number>): void

Verifies whether a specific PID and UID have the given permission. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
permission	string	Yes	Name of the permission to verify.
options	PermissionOptions	Yes	Permission options.
callback	AsyncCallback<number>	Yes	Callback used to return the permission verification result. The value 0 means that the PID and UID have the given permission, and the value -1 means the opposite.

Example

import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle.bundleManager';
let context: featureAbility.Context = featureAbility.getContext();
bundle.getBundleInfo('com.context.test', 1, (err, datainfo) =>{
    context.verifyPermission('com.example.permission', {uid:datainfo.appInfo.uid}, (error, data) =>{
        if (error && error.code !== 0) {
            console.error(`verifyPermission fail, error: ${JSON.stringify(error)}`);
        } else {
            console.log(`verifyPermission success, data: ${JSON.stringify(data)}`);
        }
    });
});

For details about getBundleInfo in the sample code, see bundleManager.

Context.verifyPermission⁷⁺

verifyPermission(permission: string, callback: AsyncCallback<number>): void

Verifies whether the current PID and UID have the given permission. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
permission	string	Yes	Name of the permission to verify.
callback	AsyncCallback<number>	Yes	Callback used to return the permission verification result. The value 0 means that the PID and UID have the given permission, and the value -1 means the opposite.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.verifyPermission('com.example.permission', (error, data) =>{
    if (error && error.code !== 0) {
        console.error(`verifyPermission fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`verifyPermission success, data: ${JSON.stringify(data)}`);
    }
});

Context.verifyPermission⁷⁺

verifyPermission(permission: string, options?: PermissionOptions): Promise<number>

Verifies whether a specific PID and UID have the given permission. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
permission	string	Yes	Name of the permission to verify.
options	PermissionOptions	No	Permission options.

Return value

Type	Description
Promise<number>	Promise used to return the permission verification result. The value 0 means that the PID and UID have the given permission, and the value -1 means the opposite.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.verifyPermission('com.context.permission', {pid:1}).then((data) => {
    console.info(`verifyPermission data: ${JSON.stringify(data)}`);
});

Context.requestPermissionsFromUser⁷⁺

requestPermissionsFromUser(permissions: Array<string>, requestCode: number, resultCallback: AsyncCallback<PermissionRequestResult>): void

Requests certain permissions from the system. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
permissions	Array<string>	Yes	Permissions to request. This parameter cannot be null.
requestCode	number	Yes	Request code to be passed to PermissionRequestResult.
resultCallback	AsyncCallback<PermissionRequestResult>	Yes	Callback used to return the permission request result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.requestPermissionsFromUser(
    ['com.example.permission1',
     'com.example.permission2',
     'com.example.permission3',
     'com.example.permission4',
     'com.example.permission5'],
    1,
    (error, data) => {
        if (error && error.code !== 0) {
            console.error(`requestPermissionsFromUser fail, error: ${JSON.stringify(error)}`);
        } else {
            console.log(`requestPermissionsFromUser success, data: ${JSON.stringify(data)}`);
        }
    }
);

Context.requestPermissionsFromUser⁷⁺

requestPermissionsFromUser(permissions: Array<string>, requestCode: number): Promise<PermissionRequestResult>

Requests certain permissions from the system. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
permissions	Array<string>	Yes	Permissions to request. This parameter cannot be null.
requestCode	number	Yes	Request code to be passed to PermissionRequestResult.

Return value

Type	Description
Promise<PermissionRequestResult>	Promise used to return the permission request result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.requestPermissionsFromUser(
    ['com.example.permission1',
     'com.example.permission2',
     'com.example.permission3',
     'com.example.permission4',
     'com.example.permission5'],
    1).then((data)=>{
        console.info(`requestPermissionsFromUser data: ${JSON.stringify(data)}`);
    }
);

Context.getApplicationInfo⁷⁺

getApplicationInfo(callback: AsyncCallback<ApplicationInfo>): void

Obtains information about the current application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<ApplicationInfo>	Yes	Callback used to return the application information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getApplicationInfo((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getApplicationInfo fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getApplicationInfo success, data: ${JSON.stringify(data)}`);
    }
});

Context.getApplicationInfo⁷⁺

getApplicationInfo(): Promise<ApplicationInfo>

Obtains information about the current application. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<ApplicationInfo>	Promise used to return the application information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getApplicationInfo().then((data) => {
    console.info(`getApplicationInfo data: ${JSON.stringify(data)}`);
});

Context.getBundleName⁷⁺

getBundleName(callback: AsyncCallback<string>): void

Obtains the bundle name of this ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the bundle name.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getBundleName((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getBundleName fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getBundleName success, data: ${JSON.stringify(data)}`);
    }
});

Context.getBundleName⁷⁺

getBundleName(): Promise<string>

Obtains the bundle name of this ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the bundle name.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getBundleName().then((data) => {
    console.info(`getBundleName data: ${JSON.stringify(data)}`);
});

Context.getDisplayOrientation⁷⁺

getDisplayOrientation(callback: AsyncCallback<bundle.DisplayOrientation>): void

Obtains the display orientation of this ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<bundle.DisplayOrientation>	Yes	Callback used to return the display orientation.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getDisplayOrientation((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getDisplayOrientation fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getDisplayOrientation success, data: ${JSON.stringify(data)}`);
    }
});

Context.getDisplayOrientation⁷⁺

getDisplayOrientation(): Promise<bundle.DisplayOrientation>;

Obtains the display orientation of this ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<bundle.DisplayOrientation>	Promise used to return the display orientation.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getDisplayOrientation().then((data) => {
    console.info(`getDisplayOrientation data: ${JSON.stringify(data)}`);
});

Context.getExternalCacheDir

getExternalCacheDir(callback: AsyncCallback<string>): void

Obtains the external cache directory of the application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the absolute path of the cache directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getExternalCacheDir((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getExternalCacheDir fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getExternalCacheDir success, data: ${JSON.stringify(data)}`);
    }
});

Context.getExternalCacheDir

getExternalCacheDir(): Promise<string>;

Obtains the external cache directory of the application. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the absolute path of the cache directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getExternalCacheDir().then((data) => {
    console.info(`getExternalCacheDir data: ${JSON.stringify(data)}`);
});

Context.setDisplayOrientation⁷⁺

setDisplayOrientation(orientation: bundle.DisplayOrientation, callback: AsyncCallback<void>): void

Sets the display orientation for this ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
orientation	bundle.DisplayOrientation	Yes	Display orientation to set.
callback	AsyncCallback<void>	Yes	Callback used to return the display orientation.

Example

import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle.bundleManager';
let context: featureAbility.Context = featureAbility.getContext();
let orientation = bundle.DisplayOrientation.UNSPECIFIED;
context.setDisplayOrientation(orientation, (error) => {
    console.error(`setDisplayOrientation fail, error: ${JSON.stringify(error)}`);
});

Context.setDisplayOrientation⁷⁺

setDisplayOrientation(orientation: bundle.DisplayOrientation): Promise<void>;

Sets the display orientation for this ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
orientation	bundle.DisplayOrientation
Promise<void>	Promise used to return the display orientation.

Example

import featureAbility from '@ohos.ability.featureAbility';
import bundle from '@ohos.bundle.bundleManager';
let context: featureAbility.Context = featureAbility.getContext();
let orientation = bundle.DisplayOrientation.UNSPECIFIED;
context.setDisplayOrientation(orientation).then((data) => {
    console.info(`setDisplayOrientation data: ${JSON.stringify(data)}`);
});

Context.setShowOnLockScreen^(deprecated)

setShowOnLockScreen(show: boolean, callback: AsyncCallback<void>): void

Sets whether to show this feature at the top of the lock screen so that the feature remains activated. This API uses an asynchronous callback to return the result. > This API is deprecated since API version 9. You are advised to use window.setShowOnLockScreen.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
show	boolean	Yes	Whether to show this feature at the top of the lock screen. The value true means to show this feature at the top of the lock screen, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
let show = true;
context.setShowOnLockScreen(show, (error) => {
    console.error(`setShowOnLockScreen fail, error: ${JSON.stringify(error)}`);
});

Context.setShowOnLockScreen^(deprecated)

setShowOnLockScreen(show: boolean): Promise<void>;

Sets whether to show this feature at the top of the lock screen so that the feature remains activated. This API uses a promise to return the result. > This API is deprecated since API version 9. You are advised to use window.setShowOnLockScreen.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
show	boolean	Yes	Whether to show this feature at the top of the lock screen. The value true means to show this feature at the top of the lock screen, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
let show = true;
context.setShowOnLockScreen(show).then((data) => {
    console.info(`setShowOnLockScreen data: ${JSON.stringify(data)}`);
});

Context.setWakeUpScreen⁷⁺

setWakeUpScreen(wakeUp: boolean, callback: AsyncCallback<void>): void

Sets whether to wake up the screen when this feature is restored. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
wakeUp	boolean	Yes	Whether to wake up the screen. The value true means to wake up the screen, and false means the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
let wakeUp = true;
context.setWakeUpScreen(wakeUp, (error) => {
    console.error(`setWakeUpScreen fail, error: ${JSON.stringify(error)}`);
});

Context.setWakeUpScreen⁷⁺

setWakeUpScreen(wakeUp: boolean): Promise<void>;

Sets whether to wake up the screen when this feature is restored. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
wakeUp	boolean	Yes	Whether to wake up the screen. The value true means to wake up the screen, and false means the opposite.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
let wakeUp = true;
context.setWakeUpScreen(wakeUp).then((data) => {
    console.info(`setWakeUpScreen data: ${JSON.stringify(data)}`);
});

Context.getProcessInfo⁷⁺

getProcessInfo(callback: AsyncCallback<ProcessInfo>): void

Obtains information about the current process, including the PID and process name. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<ProcessInfo>	Yes	Callback used to return the process information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getProcessInfo((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getProcessInfo fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getProcessInfo success, data: ${JSON.stringify(data)}`);
    }
});

Context.getProcessInfo⁷⁺

getProcessInfo(): Promise<ProcessInfo>

Obtains information about the current process, including the PID and process name. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<ProcessInfo>	Promise used to return the process information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getProcessInfo().then((data) => {
    console.info(`getProcessInfo data: ${JSON.stringify(data)}`);
});

Context.getElementName⁷⁺

getElementName(callback: AsyncCallback<ElementName>): void

Obtains the ohos.bundleManager.ElementName object of this ability. This API uses an asynchronous callback to return the result.

This API is available only to Page abilities.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<ElementName>	Yes	Callback used to return the ohos.bundleManager.ElementName object.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getElementName((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getElementName fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getElementName success, data: ${JSON.stringify(data)}`);
    }
});

Context.getElementName⁷⁺

getElementName(): Promise<ElementName>

Obtains the ohos.bundleManager.ElementName object of this ability. This API uses a promise to return the result.

This API is available only to Page abilities.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<ElementName>	Promise used to return the ohos.bundleManager.ElementName object.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getElementName().then((data) => {
    console.info(`getElementName data: ${JSON.stringify(data)}`);
});

Context.getProcessName⁷⁺

getProcessName(callback: AsyncCallback<string>): void

Obtains the name of the current process. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the process name.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getProcessName((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getProcessName fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getProcessName success, data: ${JSON.stringify(data)}`);
    }
});

Context.getProcessName⁷⁺

getProcessName(): Promise<string>

Obtains the name of the current process. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the process name.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getProcessName().then((data) => {
    console.info(`getProcessName data: ${JSON.stringify(data)}`);
});

Context.getCallingBundle⁷⁺

getCallingBundle(callback: AsyncCallback<string>): void

Obtains the bundle name of the caller ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the bundle name.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getCallingBundle((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getCallingBundle fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getCallingBundle success, data: ${JSON.stringify(data)}`);
    }
});

Context.getCallingBundle⁷⁺

getCallingBundle(): Promise<string>

Obtains the bundle name of the caller ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the bundle name.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getCallingBundle().then((data) => {
    console.info(`getCallingBundle data: ${JSON.stringify(data)}`);
});

Context.getCacheDir

getCacheDir(callback: AsyncCallback<string>): void

Obtains the cache directory of the application in the internal storage. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the cache directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getCacheDir((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getCacheDir fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getCacheDir success, data: ${JSON.stringify(data)}`);
    }
});

Context.getCacheDir

getCacheDir(): Promise<string>

Obtains the cache directory of the application in the internal storage. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the cache directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getCacheDir().then((data) => {
    console.info(`getCacheDir data: ${JSON.stringify(data)}`);
});

Context.getFilesDir

getFilesDir(callback: AsyncCallback<string>): void

Obtains the file directory of the application in the internal storage. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the file directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getFilesDir((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getFilesDir fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getFilesDir success, data: ${JSON.stringify(data)}`);
    }
});

Context.getFilesDir

getFilesDir(): Promise<string>

Obtains the file directory of the application in the internal storage. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the file directory.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getFilesDir().then((data) => {
    console.info(`getFilesDir data: ${JSON.stringify(data)}`);
});

Context.getOrCreateDistributedDir⁷⁺

getOrCreateDistributedDir(callback: AsyncCallback<string>): void

Obtains the distributed file path for storing ability or application data files. This API uses an asynchronous callback to return the result.

If the distributed file path does not exist, the system will create one and return the created path.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the distributed file path. If the path does not exist, the system will create one and return the created path.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getOrCreateDistributedDir((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getOrCreateDistributedDir fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getOrCreateDistributedDir success, data: ${JSON.stringify(data)}`);
    }
});

Context.getOrCreateDistributedDir⁷⁺

getOrCreateDistributedDir(): Promise<string>

Obtains the distributed file path for storing ability or application data files. This API uses a promise to return the result.

If the distributed file path does not exist, the system will create one and return the created path.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the distributed file path. If this API is called for the first time, a path will be created.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getOrCreateDistributedDir().then((data) => {
    console.info(`getOrCreateDistributedDir data: ${JSON.stringify(data)}`);
});

Context.getAppType⁷⁺

getAppType(callback: AsyncCallback<string>): void

Obtains the application type. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<string>	Yes	Callback used to return the application type.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getAppType((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getAppType fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getAppType success, data: ${JSON.stringify(data)}`);
    }
});

Context.getAppType⁷⁺

getAppType(): Promise<string>

Obtains the application type. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<string>	Promise used to return the application type.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getAppType().then((data) => {
    console.info(`getAppType data: ${JSON.stringify(data)}`);
});

Context.getHapModuleInfo⁷⁺

getHapModuleInfo(callback: AsyncCallback<HapModuleInfo>): void

Obtains the ModuleInfo object of the application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<HapModuleInfo>	Yes	Callback used to return the ModuleInfo object.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getHapModuleInfo((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getHapModuleInfo fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getHapModuleInfo success, data: ${JSON.stringify(data)}`);
    }
});

Context.getHapModuleInfo⁷⁺

getHapModuleInfo(): Promise<HapModuleInfo>

Obtains the ModuleInfo object of the application. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<HapModuleInfo>	Promise used to return the ModuleInfo object.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getHapModuleInfo().then((data) => {
    console.info(`getHapModuleInfo data: ${JSON.stringify(data)}`);
});

Context.getAppVersionInfo⁷⁺

getAppVersionInfo(callback: AsyncCallback<AppVersionInfo>): void

Obtains the version information of the application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<AppVersionInfo>	Yes	Callback used to return the version information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getAppVersionInfo((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getAppVersionInfo fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getAppVersionInfo success, data: ${JSON.stringify(data)}`);
    }
});

Context.getAppVersionInfo⁷⁺

getAppVersionInfo(): Promise<AppVersionInfo>

Obtains the version information of the application. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<AppVersionInfo>	Promise used to return the version information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getAppVersionInfo().then((data) => {
    console.info(`getAppVersionInfo data: ${JSON.stringify(data)}`);
});

Context.getAbilityInfo⁷⁺

getAbilityInfo(callback: AsyncCallback<AbilityInfo>): void

Obtains information about this ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<AbilityInfo>	Yes	Callback used to return the ability information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getAbilityInfo((error, data) => {
    if (error && error.code !== 0) {
        console.error(`getAbilityInfo fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`getAbilityInfo success, data: ${JSON.stringify(data)}`);
    }
});

Context.getAbilityInfo⁷⁺

getAbilityInfo(): Promise<AbilityInfo>

Obtains information about this ability. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<AbilityInfo>	Promise used to return the ability information.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.getAbilityInfo().then((data) => {
    console.info(`getAbilityInfo data: ${JSON.stringify(data)}`);
});

Context.getApplicationContext⁷⁺

getApplicationContext(): Context

Obtains the context of the application.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Context	Application context.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext().getApplicationContext();

Context.isUpdatingConfigurations⁷⁺

isUpdatingConfigurations(callback: AsyncCallback<boolean>): void;

Checks whether the configuration of this ability is being updated. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Returns true if the configuration of the capability is being updated; returns false otherwise.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.isUpdatingConfigurations((error, data) => {
    if (error && error.code !== 0) {
        console.error(`isUpdatingConfigurations fail, error: ${JSON.stringify(error)}`);
    } else {
        console.log(`isUpdatingConfigurations success, data: ${JSON.stringify(data)}`);
    }
});

Context.isUpdatingConfigurations⁷⁺

isUpdatingConfigurations(): Promise<boolean>;

Checks whether the configuration of this ability is being updated. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<boolean>	Returns true if the configuration of the capability is being updated; returns false otherwise.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.isUpdatingConfigurations().then((data) => {
    console.info(`isUpdatingConfigurations data: ${JSON.stringify(data)}`);
});

Context.printDrawnCompleted⁷⁺

printDrawnCompleted(callback: AsyncCallback<void>): void;

Notifies the system of the time required to draw this page function. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.printDrawnCompleted((err) => {
    console.error(`printDrawnCompleted err: ${JSON.stringify(err)}`);
});

Context.printDrawnCompleted⁷⁺

printDrawnCompleted(): Promise<void>;

Notifies the system of the time required to draw this page function. This API uses a promise to return the result.

System capability: SystemCapability.Ability.AbilityRuntime.Core

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

import featureAbility from '@ohos.ability.featureAbility';
let context: featureAbility.Context = featureAbility.getContext();
context.printDrawnCompleted().then((data) => {
    console.info(`printDrawnCompleted data: ${JSON.stringify(data)}`);
});

PermissionOptions⁷⁺

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Type	Mandatory	Description
pid	number	No	Process ID.
uid	number	No	User ID.

PermissionRequestResult⁷⁺

System capability: SystemCapability.Ability.AbilityRuntime.Core

Name	Type	Mandatory	Description
requestCode	number	Yes	Request code passed.
permissions	Array<string>	Yes	Permissions requested.
authResults	Array<number>	Yes	Permission request result.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/2287be8893cf4171871f3354cef8d843

harmony 鸿蒙Context

Context

Modules to Import

Usage

Context.getOrCreateLocalDir7+

Context.getOrCreateLocalDir7+

Context.verifyPermission7+

Context.verifyPermission7+

Context.verifyPermission7+

Context.requestPermissionsFromUser7+

Context.requestPermissionsFromUser7+

Context.getApplicationInfo7+

Context.getApplicationInfo7+

Context.getBundleName7+

Context.getBundleName7+

Context.getDisplayOrientation7+

Context.getDisplayOrientation7+

Context.getExternalCacheDir

Context.getExternalCacheDir

Context.setDisplayOrientation7+

Context.setDisplayOrientation7+

Context.setShowOnLockScreen(deprecated)

Context.setShowOnLockScreen(deprecated)

Context.setWakeUpScreen7+

Context.setWakeUpScreen7+

Context.getProcessInfo7+

Context.getProcessInfo7+

Context.getElementName7+

Context.getElementName7+

Context.getProcessName7+

Context.getProcessName7+

Context.getCallingBundle7+

Context.getCallingBundle7+

Context.getCacheDir

Context.getCacheDir

Context.getFilesDir

Context.getFilesDir

Context.getOrCreateDistributedDir7+

Context.getOrCreateDistributedDir7+

Context.getAppType7+

Context.getAppType7+

Context.getHapModuleInfo7+

Context.getHapModuleInfo7+

Context.getAppVersionInfo7+

Context.getAppVersionInfo7+

Context.getAbilityInfo7+

Context.getAbilityInfo7+

Context.getApplicationContext7+

Context.isUpdatingConfigurations7+

Context.isUpdatingConfigurations7+

Context.printDrawnCompleted7+

Context.printDrawnCompleted7+

PermissionOptions7+

PermissionRequestResult7+

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

Context.getOrCreateLocalDir⁷⁺

Context.getOrCreateLocalDir⁷⁺

Context.verifyPermission⁷⁺

Context.verifyPermission⁷⁺

Context.verifyPermission⁷⁺

Context.requestPermissionsFromUser⁷⁺

Context.requestPermissionsFromUser⁷⁺

Context.getApplicationInfo⁷⁺

Context.getApplicationInfo⁷⁺

Context.getBundleName⁷⁺

Context.getBundleName⁷⁺

Context.getDisplayOrientation⁷⁺

Context.getDisplayOrientation⁷⁺

Context.setDisplayOrientation⁷⁺

Context.setDisplayOrientation⁷⁺

Context.setShowOnLockScreen^(deprecated)

Context.setShowOnLockScreen^(deprecated)

Context.setWakeUpScreen⁷⁺

Context.setWakeUpScreen⁷⁺

Context.getProcessInfo⁷⁺

Context.getProcessInfo⁷⁺

Context.getElementName⁷⁺

Context.getElementName⁷⁺

Context.getProcessName⁷⁺

Context.getProcessName⁷⁺

Context.getCallingBundle⁷⁺

Context.getCallingBundle⁷⁺

Context.getOrCreateDistributedDir⁷⁺

Context.getOrCreateDistributedDir⁷⁺

Context.getAppType⁷⁺

Context.getAppType⁷⁺

Context.getHapModuleInfo⁷⁺

Context.getHapModuleInfo⁷⁺

Context.getAppVersionInfo⁷⁺

Context.getAppVersionInfo⁷⁺

Context.getAbilityInfo⁷⁺

Context.getAbilityInfo⁷⁺

Context.getApplicationContext⁷⁺

Context.isUpdatingConfigurations⁷⁺

Context.isUpdatingConfigurations⁷⁺

Context.printDrawnCompleted⁷⁺

Context.printDrawnCompleted⁷⁺

PermissionOptions⁷⁺

PermissionRequestResult⁷⁺