@ohos.ability.particleAbility (ParticleAbility模块)

particleAbility模块提供了操作Service类型的Ability的能力，包括启动、停止指定的particleAbility，获取dataAbilityHelper，连接、断连指定的ServiceAbility等。

说明：

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

使用限制

particleAbility模块用来对Data和Service类型的Ability进行操作。

导入模块

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

particleAbility.startAbility

startAbility(parameter: StartAbilityParameter, callback: AsyncCallback<void>): void

启动指定的particleAbility（callback形式）。

使用规则：

调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
跨应用场景下，目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
组件启动规则详见：组件启动规则（FA模型）

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

参数：

参数名	类型	必填	说明
parameter	StartAbilityParameter	是	表示启动的ability
callback	AsyncCallback<void>	是	以callback的形式返回启动Ability的结果

示例：

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

particleAbility.startAbility(
    {
        want:
        {
            action: 'ohos.want.action.home',
            entities: ['entity.system.home'],
            type: 'MIMETYPE',
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
            deviceId: '',
            bundleName: 'com.example.Data',
            abilityName: 'EntryAbility',
            uri: ''
        },
    },
    (error, data) => {
        if (error && error.code !== 0) {
            console.error('startAbility fail, error: ${JSON.stringify(error)}');
        } else {
            console.log('startAbility success, data: ${JSON.stringify(data)}');
        }
    },
);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

particleAbility.startAbility

startAbility(parameter: StartAbilityParameter): Promise<void>;

启动指定的particleAbility（Promise形式）。

使用规则：

调用方应用位于后台时，使用该接口启动Ability需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
跨应用场景下，目标Ability的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
组件启动规则详见：组件启动规则（FA模型）

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

参数：

参数名	类型	必填	说明
parameter	StartAbilityParameter	是	表示启动的ability

返回值：

类型	说明
Promise<void>	Promise形式返回启动Ability的结果。

示例：

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

particleAbility.startAbility(
    {
        want:
        {
            action: 'ohos.want.action.home',
            entities: ['entity.system.home'],
            type: 'MIMETYPE',
            flags: wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
            deviceId: '',
            bundleName: 'com.example.Data',
            abilityName: 'EntryAbility',
            uri: ''
        },
    },
).then((data) => {
    console.info('particleAbility startAbility');
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

particleAbility.terminateSelf

terminateSelf(callback: AsyncCallback<void>): void

销毁当前particleAbility（callback形式）。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	以callback的形式返回停止当前Ability结果

示例：

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

particleAbility.terminateSelf(
    (error, data) => {
        if (error && error.code !== 0) {
            console.error('terminateSelf fail, error: ${JSON.stringify(error)}');
        } else {
            console.log('terminateSelf success, data: ${JSON.stringify(data)}');
        }
    }
);

1
2
3
4
5
6
7
8
9
10
11

particleAbility.terminateSelf

terminateSelf(): Promise<void>

销毁当前particleAbility（Promise形式）。

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

返回值：

类型	说明
Promise<void>	使用Promise形式返回停止当前Ability结果。

示例：

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

particleAbility.terminateSelf().then((data) => {
	console.info('particleAbility terminateSelf');
});

1
2
3
4
5

particleAbility.acquireDataAbilityHelper

acquireDataAbilityHelper(uri: string): DataAbilityHelper

获取dataAbilityHelper对象。

使用规则：

跨应用访问dataAbility，对端应用需配置关联启动
调用方应用位于后台时，使用该接口访问dataAbility需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
跨应用场景下，目标dataAbility的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
组件启动规则详见：组件启动规则（FA模型）

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

参数：

参数名	类型	必填	说明
uri	string	是	表示要打开的文件的路径。

返回值：

类型	说明
DataAbilityHelper	用来协助其他Ability访问DataAbility的工具类。

示例：

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

let uri = '';
particleAbility.acquireDataAbilityHelper(uri);

1
2
3
4

particleAbility.startBackgroundRunning

startBackgroundRunning(id: number, request: NotificationRequest, callback: AsyncCallback<void>): void;

向系统申请长时任务，使用callback形式返回结果，建议使用新接口backgroundTaskManager.startBackgroundRunning。

需要权限: ohos.permission.KEEP_BACKGROUND_RUNNING

系统能力：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

参数：

参数名	类型	必填	说明
id	number	是	长时任务通知id号
request	NotificationRequest	是	通知参数，用于显示通知栏的信息
callback	AsyncCallback<void>	是	callback形式返回启动长时任务的结果

示例：

import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility';
import wantAgent from '@ohos.app.ability.wantAgent';

function callback(error, data) {
    if (error && error.code !== 0) {
        console.error('Operation failed error: ${JSON.stringify(error)}');
    } else {
        console.info('Operation succeeded, data: ${data}');
    }
}

let wantAgentInfo = {
    wants: [
        {
            bundleName: 'com.example.myapplication',
            abilityName: 'EntryAbility'
        }
    ],
    operationType: wantAgent.OperationType.START_ABILITY,
    requestCode: 0,
    wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
    let basicContent = {
        title: 'title',
        text: 'text'
    };
    let notificationContent = {
        contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: basicContent
    };
    let request = {
        content: notificationContent,
        wantAgent: wantAgentObj
    };
    let id = 1;
    particleAbility.startBackgroundRunning(id, request, callback);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

particleAbility.startBackgroundRunning

startBackgroundRunning(id: number, request: NotificationRequest): Promise<void>

需要权限: ohos.permission.KEEP_BACKGROUND_RUNNING

系统能力：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

向系统申请长时任务，使用promise形式返回结果，建议使用新接口backgroundTaskManager.startBackgroundRunning。

参数：

参数名	类型	必填	说明
id	number	是	长时任务通知id号
request	NotificationRequest	是	通知参数，用于显示通知栏的信息

返回值：

类型	说明
Promise<void>	使用Promise形式返回启动长时任务的结果。

示例：

import notification from '@ohos.notification';
import particleAbility from '@ohos.ability.particleAbility';
import wantAgent from '@ohos.app.ability.wantAgent';

let wantAgentInfo = {
    wants: [
        {
            bundleName: 'com.example.myapplication',
            abilityName: 'EntryAbility'
        }
    ],
    operationType: wantAgent.OperationType.START_ABILITY,
    requestCode: 0,
    wantAgentFlags: [wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
};

wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => {
    let basicContent = {
        title: 'title',
        text: 'text'
    };
    let notificationContent = {
        contentType: notification.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
        normal: basicContent
    };
    let request = {
        content: notificationContent,
        wantAgent: wantAgentObj
    };
    let id = 1;
    particleAbility.startBackgroundRunning(id, request).then(() => {
        console.info('Operation succeeded');
    }).catch((err) => {
        console.error('Operation failed cause: ${JSON.stringify(err)}');
    });
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

particleAbility.cancelBackgroundRunning

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

向系统申请取消长时任务，使用callback形式返回结果，建议使用新接口backgroundTaskManager.stopBackgroundRunning。

系统能力：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	callback形式返回取消长时任务的结果

示例：

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

function callback(error, data) {
    if (error && error.code !== 0) {
        console.error('Operation failed error: ${JSON.stringify(error)}');
    } else {
        console.info('Operation succeeded, data: ${data}');
    }
}

particleAbility.cancelBackgroundRunning(callback);

1
2
3
4
5
6
7
8
9
10
11
12

particleAbility.cancelBackgroundRunning

cancelBackgroundRunning(): Promise<void>;

向系统申请取消长时任务，使用promise形式返回结果，建议使用新接口backgroundTaskManager.stopBackgroundRunning。

系统能力：SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask

返回值：

类型	说明
Promise<void>	使用Promise形式返回取消长时任务的结果。

示例：

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

particleAbility.cancelBackgroundRunning().then(() => {
    console.info('Operation succeeded');
}).catch((err) => {
    console.error('Operation failed cause: ${JSON.stringify(err)}');
});

1
2
3
4
5
6
7
8

particleAbility.connectAbility

connectAbility(request: Want, options:ConnectOptions): number

将当前ability与指定的ServiceAbility进行连接（callback形式）。

使用规则：

跨应用连接serviceAbility，对端应用需配置关联启动
调用方应用位于后台时，使用该接口连接serviceAbility需申请ohos.permission.START_ABILITIES_FROM_BACKGROUND权限
跨应用场景下，目标serviceAbility的exported属性若配置为false，调用方应用需申请ohos.permission.START_INVISIBLE_ABILITY权限
组件启动规则详见：组件启动规则（FA模型）

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

参数：

参数名	类型	必填	说明
request	Want	是	表示被连接的ServiceAbility。
options	ConnectOptions	是	连接回调方法。

示例：

import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc';

function onConnectCallback(element, remote) {
    console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
}

function onDisconnectCallback(element) {
    console.log('ConnectAbility onDisconnect element.deviceId: ${element.deviceId}');
}

function onFailedCallback(code) {
    console.error('particleAbilityTest ConnectAbility onFailed errCode: ${code}');
}

let connId = particleAbility.connectAbility(
    {
        bundleName: 'com.ix.ServiceAbility',
        abilityName: 'ServiceAbilityA',
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);

particleAbility.disconnectAbility(connId).then((data) => {
    console.log('data: ${data}');
}).catch((error) => {
    console.error('particleAbilityTest result errCode: ${error.code}');
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

particleAbility.disconnectAbility

disconnectAbility(connection: number, callback:AsyncCallback<void>): void;

断开当前ability与指定ServiceAbility的连接（callback形式）。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	callback形式返回断开连接的结果

示例：

import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc';

function onConnectCallback(element, remote) {
    console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
}

function onDisconnectCallback(element) {
    console.log('ConnectAbility onDisconnect element.deviceId: ${element.deviceId}');
}

function onFailedCallback(code) {
    console.error('particleAbilityTest ConnectAbility onFailed errCode: ${code}');
}

let connId = particleAbility.connectAbility(
    {
        bundleName: 'com.ix.ServiceAbility',
        abilityName: 'ServiceAbilityA',
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);

particleAbility.disconnectAbility(connId, (err) => {
    console.error('particleAbilityTest disconnectAbility err: ${JSON.stringify(err)}');
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

particleAbility.disconnectAbility

disconnectAbility(connection: number): Promise<void>;

断开当前ability与指定ServiceAbility的连接（Promise形式）。

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

返回值：

类型	说明
Promise<void>	使用Promise形式返回结果。

示例：

import particleAbility from '@ohos.ability.particleAbility';
import rpc from '@ohos.rpc';

function onConnectCallback(element, remote) {
    console.log('ConnectAbility onConnect remote is proxy: ${(remote instanceof rpc.RemoteProxy)}');
}

function onDisconnectCallback(element) {
    console.log('ConnectAbility onDisconnect element.deviceId: ${element.deviceId}');
}

function onFailedCallback(code) {
    console.error('particleAbilityTest ConnectAbility onFailed errCode: ${code}');
}

let connId = particleAbility.connectAbility(
    {
        bundleName: 'com.ix.ServiceAbility',
        abilityName: 'ServiceAbilityA',
    },
    {
        onConnect: onConnectCallback,
        onDisconnect: onDisconnectCallback,
        onFailed: onFailedCallback,
    },
);

particleAbility.disconnectAbility(connId).then((data) => {
    console.log(' data: ${data}');
}).catch((error) => {
    console.error('particleAbilityTest result errCode : ${error.code}');
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

ErrorCode

表示错误码。

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

名称	值	说明
INVALID_PARAMETER	-1	无效的参数。

@ohos.ability.particleAbility (ParticleAbility模块)

@ohos.ability.particleAbility (ParticleAbility模块)

使用限制

导入模块

particleAbility.startAbility

particleAbility.startAbility

particleAbility.terminateSelf

particleAbility.terminateSelf

particleAbility.acquireDataAbilityHelper

particleAbility.startBackgroundRunning

particleAbility.startBackgroundRunning

particleAbility.cancelBackgroundRunning

particleAbility.cancelBackgroundRunning

particleAbility.connectAbility

particleAbility.disconnectAbility

particleAbility.disconnectAbility

ErrorCode

Description