@ohos.distributedMissionManager (分布式任务管理)

分布式任务管理模块提供跨设备系统任务管理能力，包括注册系统任务状态监听、取消系统任务状态监听、开始同步远端任务列表、停止同步远端任务列表、迁移任务操作。

说明：

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

本模块接口为系统接口。

导入模块

import distributedMissionManager from '@ohos.distributedMissionManager'

distributedMissionManager.registerMissionListener

registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, callback: AsyncCallback<void>): void;

注册系统任务状态监听，以回调函数的方式返回。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionDeviceInfo	是	注册监听设备信息。
options	MissionCallback	是	注册的回调方法。
callback	AsyncCallback<void>	是	执行结果回调函数。

示例：

function NotifyMissionsChanged(deviceId) {
    console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId));
}
function NotifySnapshot(deviceId, missionId) {
    console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId));
    console.log('NotifySnapshot missionId ' + JSON.stringify(missionId));
}
function NotifyNetDisconnect(deviceId, state) {
    console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId));
    console.log('NotifyNetDisconnect state ' + JSON.stringify(state));
}
var parameter =  {
    deviceId: ""
};
var options = {
    notifyMissionsChanged: NotifyMissionsChanged,
    notifySnapshot: NotifySnapshot,
    notifyNetDisconnect: NotifyNetDisconnect
}
try {
    distributedMissionManager.registerMissionListener(parameter, options, (error) => {
        if (error.code != 0) {
            console.error('registerMissionListener failed, cause: ' + JSON.stringify(error))
        }
        console.info('registerMissionListener finished')
    })
} catch (error) {
    console.error('registerMissionListener failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.registerMissionListener

registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback): Promise<void>

注册系统任务状态监听，以promise的方式返回。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionDeviceInfo	是	设备信息。
options	MissionCallback	是	注册的回调方法。

返回值：

类型	说明
Promise<void>	promise方式返回执行结果。

示例：

function NotifyMissionsChanged(deviceId) {
    console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId));
}
function NotifySnapshot(deviceId, missionId) {
    console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId));
    console.log('NotifySnapshot missionId ' + JSON.stringify(missionId));
}
function NotifyNetDisconnect(deviceId, state) {
    console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId));
    console.log('NotifyNetDisconnect state ' + JSON.stringify(state));
}
var parameter =  {
    deviceId: ""
};
var options = {
    notifyMissionsChanged: NotifyMissionsChanged,
    notifySnapshot: NotifySnapshot,
    notifyNetDisconnect: NotifyNetDisconnect
}
try {
    distributedMissionManager.registerMissionListener(parameter, options)
    .then(data => {
        console.info('registerMissionListener finished, ' + JSON.stringify(data));
    }).catch(error => {
        console.error('registerMissionListener failed, cause: ' + JSON.stringify(error));
    })
} catch (error) {
    console.error('registerMissionListener failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.unRegisterMissionListener

unRegisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback<void>): void;

取消任务状态监听, 以回调函数的方式返回。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionDeviceInfo	是	设备信息。
callback	AsyncCallback<void>	是	执行结果回调函数。

示例：

var parameter =  {
    deviceId: ""
};
try {
    distributedMissionManager.unRegisterMissionListener(parameter, (error) => {
        if (error.code != 0) {
            console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error))
        }
        console.info('unRegisterMissionListener finished')
    })
} catch (error) {
    console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.unRegisterMissionListener

unRegisterMissionListener(parameter: MissionDeviceInfo): Promise<void>

取消任务状态监听，以promise方式返回执行结果。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionDeviceInfo	是	设备信息。

返回值：

类型	说明
Promise<void>	promise方式返回执行结果。

示例：

var parameter =  {
    deviceId: ""
};
try {
    distributedMissionManager.unRegisterMissionListener(parameter)
    .then(data => {
        console.info('unRegisterMissionListener finished, ' + JSON.stringify(data));
    }).catch(error => {
        console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error));
    })
} catch (error) {
    console.error('unRegisterMissionListener failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.startSyncRemoteMissions

startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback<void>): void;

开始同步远端任务列表, 以回调函数的方式返回。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionParameter	是	同步信息。
callback	AsyncCallback<void>	是	执行结果回调函数。

示例：

var parameter =  {
    deviceId: "",
    fixConflict: false, 
    tag: 0
};
try {
    distributedMissionManager.startSyncRemoteMissions(parameter, (error) => {
        if (error.code != 0) {
            console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error))
        }
        console.info('startSyncRemoteMissions finished')
    })
} catch (error) {
    console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.startSyncRemoteMissions

startSyncRemoteMissions(parameter: MissionParameter): Promise<void>

开始同步远端任务列表，以promise方式返回执行结果。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionParameter	是	同步信息。

返回值：

类型	说明
Promise<void>	promise方式返回执行结果。

示例：

var parameter =  {
    deviceId: "",
    fixConflict: false, 
    tag: 0
};
try {
    distributedMissionManager.startSyncRemoteMissions(parameter)
    .then(data => {
        console.info('startSyncRemoteMissions finished, ' + JSON.stringify(data));
    }).catch(error => {
        console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error));
    })
} catch (error) {
    console.error('startSyncRemoteMissions failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.stopSyncRemoteMissions

stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback<void>): void;

停止同步远端任务列表, 以回调函数的方式返回。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionDeviceInfo	是	同步信息。
callback	AsyncCallback<void>	是	执行结果回调函数。

示例：

var parameter =  {
    deviceId: ""
};
try {
    distributedMissionManager.stopSyncRemoteMissions(parameter, (error) => {
        if (error.code != 0) {
            console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error))
        }
        console.info('stopSyncRemoteMissions finished')
    })
} catch (error) {
    console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.stopSyncRemoteMissions

stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise<void>

停止同步远端任务列表，以promise方式返回执行结果。

需要权限：ohos.permission.MANAGE_MISSIONS

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

参数：

参数名	类型	必填	说明
parameter	MissionDeviceInfo	是	同步信息。

返回值：

类型	说明
Promise<void>	promise方式返回执行结果。

示例：

var parameter =  {
    deviceId: ""
};
try {
    distributedMissionManager.stopSyncRemoteMissions(parameter)
    .then(data => {
        console.info('stopSyncRemoteMissions finished, ' + JSON.stringify(data));
    }).catch(error => {
        console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error));
    })
} catch (error) {
    console.error('stopSyncRemoteMissions failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.continueMission

continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callback: AsyncCallback<void>): void;

迁移任务，以回调函数的方式返回。

需要权限：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名	类型	必填	说明
parameter	ContinueDeviceInfo	是	迁移信息。
options	ContinueCallback	是	迁移任务完成回调函数。
callback	AsyncCallback<void>	是	执行结果回调函数。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
16300501	The system ability work abnormally.
16300502	Failed to get the missionInfo of the specified missionId.
16300503	The application is not installed on the remote end and installation-free is not supported.
16300504	The application is not installed on the remote end but installation-free is supported, try again with freeInstall flag.
16300505	The operation device must be the device where the application to be continued is located or the target device to be continued.
16300506	The local continuation task is already in progress.

示例：

var parameter =  {
    srcDeviceId: "",
    dstDeviceId: "",
    missionId: 1,
    wantParam: {"key": "value"}
};
function onContinueDone(resultCode) {
    console.log('onContinueDone resultCode: ' + JSON.stringify(resultCode));
};
var options = {
    onContinueDone: onContinueDone
};
try {
    distributedMissionManager.continueMission(parameter, options, (error) => {
        if (error.code != 0) {
            console.error('continueMission failed, cause: ' + JSON.stringify(error))
        }
        console.info('continueMission finished')
    })
} catch (error) {
    console.error('continueMission failed, cause: ' + JSON.stringify(error))
}

distributedMissionManager.continueMission

continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promise<void>

迁移任务，以promise方式返回执行结果。

需要权限：ohos.permission.MANAGE_MISSIONS，ohos.permission.DISTRIBUTED_DATASYNC

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

参数：

参数名	类型	必填	说明
parameter	ContinueDeviceInfo	是	迁移信息。
options	ContinueCallback	是	迁移任务完成回调函数。

返回值：

类型	说明
Promise<void>	promise方式返回执行结果。

错误码：

以下错误码的详细介绍请参见分布式调度错误码。

错误码ID	错误信息
16300501	The system ability work abnormally.
16300502	Failed to get the missionInfo of the specified missionId.
16300503	The application is not installed on the remote end and installation-free is not supported.
16300504	The application is not installed on the remote end but installation-free is supported, try again with freeInstall flag.
16300505	The operation device must be the device where the application to be continued is located or the target device to be continued.
16300506	The local continuation task is already in progress.

示例：

var parameter =  {
    srcDeviceId: "",
    dstDeviceId: "",
    missionId: 1,
    wantParam: {"key": "value"}
};
function onContinueDone(resultCode) {
    console.log('onContinueDone resultCode: ' + JSON.stringify(resultCode));
};
var options = {
    onContinueDone: onContinueDone
};
try {
    distributedMissionManager.continueMission(parameter, options)
    .then(data => {
        console.info('continueMission finished, ' + JSON.stringify(data));
    }).catch(error => {
        console.error('continueMission failed, cause: ' + JSON.stringify(error));
    })
} catch (error) {
    console.error('continueMission failed, cause: ' + JSON.stringify(error))
}

MissionCallback

表示开始同步后，建立的回调函数。

需要权限：ohos.permission.MANAGE_MISSIONS

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

名称	类型	可读	可写	说明
notifyMissionsChanged	function	是	否	通知任务变化，返回设备ID。
notifySnapshot	function	是	否	通知快照变化，返回设备ID，任务ID
notifyNetDisconnect	function	是	否	通知断开连接，返回设备ID，网络状态

MissionParameter

表示同步时所需参数的枚举。

需要权限：ohos.permission.MANAGE_MISSIONS

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

名称	类型	可读	可写	说明
deviceId	string	是	是	表示设备ID。
fixConflict	boolean	是	是	表示是否存在版本冲突。
tag	number	是	是	表示特定的标签。

MissionDeviceInfo

表示注册监听时所需参数的枚举。

需要权限：ohos.permission.MANAGE_MISSIONS

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

名称	类型	可读	可写	说明
deviceId	string	是	是	表示设备ID。