@ohos.distributedMissionManager (Distributed Mission Management)

The distributedMissionManager module implements system mission management across devices. You can use the APIs provided by this module to register or deregister a mission status listener, start or stop synchronizing a remote mission list, and continue a mission on a remote device.

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 provided by this module are system APIs.

Modules to Import

import distributedMissionManager from '@ohos.distributedMissionManager'

distributedMissionManager.registerMissionListener

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

Registers a mission status listener. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Example

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>

Registers a mission status listener. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Return value

Example

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;

Deregisters a mission status listener. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Example

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>

Deregisters a mission status listener. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Return value

Example

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;

Starts to synchronize the remote mission list. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Example

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>

Starts to synchronize the remote mission list. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Return value

Example

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;

Stops synchronizing the remote mission list. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Example

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>

Stops synchronizing the remote mission list. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Return value

Example

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;

Continues a mission on a remote device. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS and ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Error codes

For details about the error codes, see Distributed Scheduler Error Codes.

Example

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>

Continues a mission on a remote device. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS and ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Parameters

Return value

Error codes

For details about the error codes, see Distributed Scheduler Error Codes.

Example

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

Defines the callbacks that can be registered as a mission status listener.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

MissionParameter

Defines the parameters required for mission synchronization.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

MissionDeviceInfo

Defines the parameters required for registering a listener.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission