@ohos.continuation.continuationManager (continuationManager)

The continuationManager module provides the continuation management entry. You can use the APIs of this module to connect to and cancel the continuation management service, subscribe to and unsubscribe from device connection events, start the device selection module, and update the device connection state.

Currently, this module provides incomplete functions, and its APIs are mainly used to start the device selection module. The continuation capability is not available for application development.

NOTE

The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import continuationManager from '@ohos.continuation.continuationManager'

continuationManager.register^(deprecated)

register(callback: AsyncCallback<number>): void;

Registers the continuation management service and obtains a token. This API does not involve any filter parameters and uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use registerContinuation instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = -1;
continuationManager.register((err, data) => {
  if (err.code != 0) {
    console.error('register failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('register finished, ' + JSON.stringify(data));
  token = data;
});

continuationManager.register^(deprecated)

register(options: ContinuationExtraParams, callback: AsyncCallback<number>): void;

Registers the continuation management service and obtains a token. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use registerContinuation instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = -1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.register(continuationExtraParams, (err, data) => {
  if (err.code != 0) {
    console.error('register failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('register finished, ' + JSON.stringify(data));
  token = data;
});

continuationManager.register^(deprecated)

register(options?: ContinuationExtraParams): Promise<number>;

Registers the continuation management service and obtains a token. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use registerContinuation instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = -1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.register(continuationExtraParams)
  .then((data) => {
    console.info('register finished, ' + JSON.stringify(data));
    token = data;
  })
  .catch((err) => {
    console.error('register failed, cause: ' + JSON.stringify(err));
  });

continuationManager.registerContinuation⁹⁺

registerContinuation(callback: AsyncCallback<number>): void;

Registers the continuation management service and obtains a token. This API does not involve any filter parameters and uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = -1;
try {
  continuationManager.registerContinuation((err, data) => {
    if (err.code != 0) {
      console.error('registerContinuation failed, cause: ' + JSON.stringify(err));
      return;
    }
    console.info('registerContinuation finished, ' + JSON.stringify(data));
    token = data;
  });
} catch (err) {
  console.error('registerContinuation failed, cause: ' + JSON.stringify(err));
}

continuationManager.registerContinuation⁹⁺

registerContinuation(options: ContinuationExtraParams, callback: AsyncCallback<number>): void;

Registers the continuation management service and obtains a token. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = -1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
try {
  continuationManager.registerContinuation(continuationExtraParams, (err, data) => {
    if (err.code != 0) {
      console.error('registerContinuation failed, cause: ' + JSON.stringify(err));
      return;
    }
    console.info('registerContinuation finished, ' + JSON.stringify(data));
    token = data;
  });
} catch (err) {
  console.error('registerContinuation failed, cause: ' + JSON.stringify(err));
}

continuationManager.registerContinuation⁹⁺

registerContinuation(options?: ContinuationExtraParams): Promise<number>;

Registers the continuation management service and obtains a token. This API uses a promise to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = -1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
try {
  continuationManager.register(continuationExtraParams)
    .then((data) => {
      console.info('registerContinuation finished, ' + JSON.stringify(data));
      token = data;
    })
    .catch((err) => {
      console.error('registerContinuation failed, cause: ' + JSON.stringify(err));
    });
} catch (err) {
  console.error('registerContinuation failed, cause: ' + JSON.stringify(err));
}

continuationManager.on("deviceConnect")^(deprecated)

on(type: "deviceConnect", callback: Callback<ContinuationResult>): void;

Subscribes to device connection events. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use on instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

continuationManager.on("deviceConnect", (data) => {
  console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id));
  console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type));
  console.info('onDeviceConnect deviceName: ' + JSON.stringify(data.name));
});

continuationManager.on("deviceDisconnect")^(deprecated)

on(type: "deviceDisconnect", callback: Callback<string>): void;

Subscribes to device disconnection events. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use on instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

continuationManager.on("deviceDisconnect", (data) => {
  console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data));
});

continuationManager.off("deviceConnect")^(deprecated)

off(type: "deviceConnect", callback?: Callback<ContinuationResult>): void;

Unsubscribes from device connection events. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use off instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

continuationManager.off("deviceConnect", (data) => {
  console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id));
  console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type));
  console.info('onDeviceConnect deviceName: ' + JSON.stringify(data.name));
});

continuationManager.off("deviceDisconnect")^(deprecated)

off(type: "deviceDisconnect", callback?: Callback<string>): void;

Unsubscribes from device disconnection events. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use off instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

continuationManager.off("deviceDisconnect", (data) => {
  console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data));
});

continuationManager.on("deviceSelected")⁹⁺

on(type: "deviceSelected", token: number, callback: Callback<Array<ContinuationResult>>): void;

Subscribes to device connection events. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
try {
  continuationManager.on("deviceSelected", token, (data) => {
    console.info('onDeviceSelected len: ' + data.length);
    for (let i = 0; i < data.length; i++) {
      console.info('onDeviceSelected deviceId: ' + JSON.stringify(data[i].id));
      console.info('onDeviceSelected deviceType: ' + JSON.stringify(data[i].type));
      console.info('onDeviceSelected deviceName: ' + JSON.stringify(data[i].name));
    }
  });
} catch (err) {
  console.error('on failed, cause: ' + JSON.stringify(err));
}

continuationManager.on("deviceUnselected")⁹⁺

on(type: "deviceUnselected", token: number, callback: Callback<Array<ContinuationResult>>): void;

Subscribes to device disconnection events. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
try {
  continuationManager.on("deviceUnselected", token, (data) => {
    console.info('onDeviceUnselected len: ' + data.length);
    for (let i = 0; i < data.length; i++) {
      console.info('onDeviceUnselected deviceId: ' + JSON.stringify(data[i].id));
      console.info('onDeviceUnselected deviceType: ' + JSON.stringify(data[i].type));
      console.info('onDeviceUnselected deviceName: ' + JSON.stringify(data[i].name));
    }
    console.info('onDeviceUnselected finished.');
  });
} catch (err) {
  console.error('on failed, cause: ' + JSON.stringify(err));
}

continuationManager.off("deviceSelected")⁹⁺

off(type: "deviceSelected", token: number): void;

Unsubscribes from device connection events.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
try {
  continuationManager.off("deviceSelected", token);
} catch (err) {
  console.error('off failed, cause: ' + JSON.stringify(err));
}

continuationManager.off("deviceUnselected")⁹⁺

off(type: "deviceUnselected", token: number): void;

Unsubscribes from device disconnection events.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
try {
  continuationManager.off("deviceUnselected", token);
} catch (err) {
  console.error('off failed, cause: ' + JSON.stringify(err));
}

continuationManager.startDeviceManager^(deprecated)

startDeviceManager(token: number, callback: AsyncCallback<void>): void;

Starts the device selection module to show the list of available devices on the network. This API does not involve any filter parameters and uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use startContinuationDeviceManager instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
continuationManager.startDeviceManager(token, (err, data) => {
  if (err.code != 0) {
    console.error('startDeviceManager failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('startDeviceManager finished, ' + JSON.stringify(data));
});

continuationManager.startDeviceManager^(deprecated)

startDeviceManager(token: number, options: ContinuationExtraParams, callback: AsyncCallback<void>): void;

Starts the device selection module to show the list of available devices on the network. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use startContinuationDeviceManager instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.startDeviceManager(token, continuationExtraParams, (err, data) => {
  if (err.code != 0) {
    console.error('startDeviceManager failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('startDeviceManager finished, ' + JSON.stringify(data));
});

continuationManager.startDeviceManager^(deprecated)

startDeviceManager(token: number, options?: ContinuationExtraParams): Promise<void>;

Starts the device selection module to show the list of available devices on the network. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use startContinuationDeviceManager instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = 1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
continuationManager.startDeviceManager(token, continuationExtraParams)
  .then((data) => {
    console.info('startDeviceManager finished, ' + JSON.stringify(data));
  })
  .catch((err) => {
    console.error('startDeviceManager failed, cause: ' + JSON.stringify(err));
  });

continuationManager.startContinuationDeviceManager⁹⁺

startContinuationDeviceManager(token: number, callback: AsyncCallback<void>): void;

Starts the device selection module to show the list of available devices on the network. This API does not involve any filter parameters and uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
try {
  continuationManager.startContinuationDeviceManager(token, (err, data) => {
    if (err.code != 0) {
      console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err));
      return;
    }
    console.info('startContinuationDeviceManager finished, ' + JSON.stringify(data));
  });
} catch (err) {
  console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err));
}

continuationManager.startContinuationDeviceManager⁹⁺

startContinuationDeviceManager(token: number, options: ContinuationExtraParams, callback: AsyncCallback<void>): void;

Starts the device selection module to show the list of available devices on the network. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
try {
  continuationManager.startContinuationDeviceManager(token, continuationExtraParams, (err, data) => {
    if (err.code != 0) {
      console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err));
      return;
    }
    console.info('startContinuationDeviceManager finished, ' + JSON.stringify(data));
  });
} catch (err) {
  console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err));
}

continuationManager.startContinuationDeviceManager⁹⁺

startContinuationDeviceManager(token: number, options?: ContinuationExtraParams): Promise<void>;

Starts the device selection module to show the list of available devices on the network. This API uses a promise to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = 1;
let continuationExtraParams = {
  deviceType: ["00E"]
};
try {
  continuationManager.startContinuationDeviceManager(token, continuationExtraParams)
    .then((data) => {
      console.info('startContinuationDeviceManager finished, ' + JSON.stringify(data));
    })
    .catch((err) => {
      console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err));
    });
} catch (err) {
  console.error('startContinuationDeviceManager failed, cause: ' + JSON.stringify(err));
}

continuationManager.updateConnectStatus^(deprecated)

updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState, callback: AsyncCallback<void>): void;

Instructs the device selection module to update the device connection state. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use updateContinuationState instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
let deviceId: string = "test deviceId";
continuationManager.updateConnectStatus(token, deviceId, continuationManager.DeviceConnectState.CONNECTED, (err, data) => {
  if (err.code != 0) {
    console.error('updateConnectStatus failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('updateConnectStatus finished, ' + JSON.stringify(data));
});

continuationManager.updateConnectStatus^(deprecated)

updateConnectStatus(token: number, deviceId: string, status: DeviceConnectState): Promise<void>;

Instructs the device selection module to update the device connection state. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use updateContinuationState instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = 1;
let deviceId: string = "test deviceId";
continuationManager.updateConnectStatus(token, deviceId, continuationManager.DeviceConnectState.CONNECTED)
  .then((data) => {
    console.info('updateConnectStatus finished, ' + JSON.stringify(data));
  })
  .catch((err) => {
    console.error('updateConnectStatus failed, cause: ' + JSON.stringify(err));
  });

continuationManager.updateContinuationState⁹⁺

updateContinuationState(token: number, deviceId: string, status: DeviceConnectState, callback: AsyncCallback<void>): void;

Instructs the device selection module to update the device connection state. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
let deviceId: string = "test deviceId";
try {
  continuationManager.updateContinuationState(token, deviceId, continuationManager.DeviceConnectState.CONNECTED, (err, data) => {
    if (err.code != 0) {
      console.error('updateContinuationState failed, cause: ' + JSON.stringify(err));
      return;
    }
    console.info('updateContinuationState finished, ' + JSON.stringify(data));
  });
} catch (err) {
  console.error('updateContinuationState failed, cause: ' + JSON.stringify(err));
}

continuationManager.updateContinuationState⁹⁺

updateContinuationState(token: number, deviceId: string, status: DeviceConnectState): Promise<void>;

Instructs the device selection module to update the device connection state. This API uses a promise to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = 1;
let deviceId: string = "test deviceId";
try {
  continuationManager.updateContinuationState(token, deviceId, continuationManager.DeviceConnectState.CONNECTED)
    .then((data) => {
      console.info('updateContinuationState finished, ' + JSON.stringify(data));
    })
    .catch((err) => {
      console.error('updateContinuationState failed, cause: ' + JSON.stringify(err));
    });
} catch (err) {
  console.error('updateContinuationState failed, cause: ' + JSON.stringify(err));
}

continuationManager.unregister^(deprecated)

unregister(token: number, callback: AsyncCallback<void>): void;

Deregisters the continuation management service. This API uses an asynchronous callback to return the result.

This API is deprecated since API version 9. You are advised to use unregisterContinuation instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
continuationManager.unregister(token, (err, data) => {
  if (err.code != 0) {
    console.error('unregister failed, cause: ' + JSON.stringify(err));
    return;
  }
  console.info('unregister finished, ' + JSON.stringify(data));
});

continuationManager.unregister^(deprecated)

unregister(token: number): Promise<void>;

Deregisters the continuation management service. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use unregisterContinuation instead.

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = 1;
continuationManager.unregister(token)
  .then((data) => {
    console.info('unregister finished, ' + JSON.stringify(data));
  })
  .catch((err) => {
    console.error('unregister failed, cause: ' + JSON.stringify(err));
  });

continuationManager.unregisterContinuation⁹⁺

unregisterContinuation(token: number, callback: AsyncCallback<void>): void;

Deregisters the continuation management service. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Error codes

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

Example

let token = 1;
try {
  continuationManager.unregisterContinuation(token, (err, data) => {
    if (err.code != 0) {
      console.error('unregisterContinuation failed, cause: ' + JSON.stringify(err));
      return;
    }
    console.info('unregisterContinuation finished, ' + JSON.stringify(data));
  });
} catch (err) {
  console.error('unregisterContinuation failed, cause: ' + JSON.stringify(err));
}

continuationManager.unregisterContinuation⁹⁺

unregisterContinuation(token: number): Promise<void>;

Deregisters the continuation management service. This API uses a promise to return the result.

Required permissions: ohos.permission.DISTRIBUTED_DATASYNC

System capability: SystemCapability.Ability.DistributedAbilityManager

Parameters

Return value

Error codes

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

Example

let token = 1;
try {
  continuationManager.unregisterContinuation(token)
    .then((data) => {
      console.info('unregisterContinuation finished, ' + JSON.stringify(data));
    })
    .catch((err) => {
      console.error('unregisterContinuation failed, cause: ' + JSON.stringify(err));
    });
} catch (err) {
  console.error('unregisterContinuation failed, cause: ' + JSON.stringify(err));
}

DeviceConnectState

Enumerates the device connection states.

System capability: SystemCapability.Ability.DistributedAbilityManager

ContinuationMode

Enumerates the continuation modes provided by the device selection module.

System capability: SystemCapability.Ability.DistributedAbilityManager