@ohos.distributedDeviceManager (Device Management)
The distributedDeviceManager module provides APIs for distributed device management.
Applications can call the APIs to:
- Subscribe to or unsubscribe from device state changes.
- Discover untrusted devices nearby.
- Authenticate or deauthenticate a device.
- Query the trusted device list.
- Query local device information, including the device name, type, and ID.
NOTE
The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import deviceManager from '@ohos.distributedDeviceManager';
deviceManager.createDeviceManager
createDeviceManager(bundleName: string): DeviceManager;
Creates a DeviceManager instance. The DeviceManager instance is the entry for invoking the APIs for distributed device management. It can be used to obtain information about trusted devices and local devices.
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
bundleName | string | Yes | Bundle name of the application. |
Return value
Type | Description |
---|---|
DeviceManager | DeviceManager instance created. |
Example
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
try {
let dmInstance = deviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
} catch(err) {
let e: BusinessError = err as BusinessError;
console.error('createDeviceManager errCode:' + e.code + ',errMessage:' + e.message);
}
deviceManager.releaseDeviceManager
releaseDeviceManager(deviceManager: DeviceManager): void;
Releases a DeviceManager instance that is no longer used.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
deviceManager | DeviceManager | Yes | DeviceManager instance to release. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
import { BusinessError } from '@ohos.base';
import deviceManager from '@ohos.distributedDeviceManager';
try {
let dmInstance = deviceManager.createDeviceManager('ohos.samples.jsHelloWorld');
deviceManager.releaseDeviceManager(dmInstance);
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('release device manager errCode:' + e.code + ',errMessage:' + e.message);
}
DeviceBasicInfo
Represents the basic information about a distributed device.
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Unique ID of the device. The value is the udid-hash (hash value of the UDID) and appid encrypted using SHA-256. |
deviceName | string | Yes | Device name. |
deviceType | string | Yes | Device type. |
networkId | string | No | Network ID of the device. |
DeviceStateChange
Enumerates the device states.
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Value | Description |
---|---|---|
UNKNOWN | 0 | The device state is unknown after the device goes online. Before the device state changes to available, distributed services cannot be used. |
AVAILABLE | 1 | The information between devices has been synchronized in the Distributed Data Service (DDS) module, and the device is ready for running distributed services. |
UNAVAILABLE | 2 | The device goes offline, and the device state is unknown. |
DeviceManager
Provides APIs to obtain information about trusted devices and local devices. Before calling any API in DeviceManager, you must use createDeviceManager to create a DeviceManager instance, for example, dmInstance.
getAvailableDeviceListSync
getAvailableDeviceListSync(): Array<DeviceBasicInfo>;
Obtains all trusted devices synchronously.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Return value
Type | Description |
---|---|
Array<DeviceBasicInfo> | List of trusted devices obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
try {
let deviceInfoList: Array<deviceManager.DeviceBasicInfo> = dmInstance.getAvailableDeviceListSync();
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getAvailableDeviceListSync errCode:' + e.code + ',errMessage:' + e.message);
}
getAvailableDeviceList
getAvailableDeviceList(callback:AsyncCallback<Array<DeviceBasicInfo>>): void;
Obtains all trusted devices. This API uses an asynchronous callback to return the result.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callback | AsyncCallback<Array<DeviceBasicInfo>> | Yes | Callback invoked to return the list of trusted devices. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
try {
dmInstance.getAvailableDeviceList((err: BusinessError, data: Array<deviceManager.DeviceBasicInfo>) => {
if (err) {
console.error('getAvailableDeviceList errCode:' + err.code + ',errMessage:' + err.message);
return;
}
console.log('get available device info: ' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getAvailableDeviceList errCode:' + e.code + ',errMessage:' + e.message);
}
getAvailableDeviceList
getAvailableDeviceList(): Promise<Array<DeviceBasicInfo>>;
Obtains all trusted devices. This API uses a promise to return the result.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Return value
Type | Description |
---|---|
Promise<Array<DeviceBasicInfo>> | Promise used to return the result. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
dmInstance.getAvailableDeviceList().then((data: Array<deviceManager.DeviceBasicInfo>) => {
console.log('get available device info: ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
console.error('getAvailableDeviceList errCode:' + err.code + ',errMessage:' + err.message);
});
getLocalDeviceNetworkId
getLocalDeviceNetworkId(): string;
Obtains the network ID of the local device.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Return value
Type | Description |
---|---|
string | Network ID of the local device obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
let deviceNetworkId: string = dmInstance.getLocalDeviceNetworkId();
console.log('local device networkId: ' + JSON.stringify(deviceNetworkId));
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getLocalDeviceNetworkId errCode:' + e.code + ',errMessage:' + e.message);
}
getLocalDeviceName
getLocalDeviceName(): string;
Obtains the local device name.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Return value
Type | Description |
---|---|
string | Name of the local device obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
let deviceName: string = dmInstance.getLocalDeviceName();
console.log('local device name: ' + JSON.stringify(deviceName));
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getLocalDeviceName errCode:' + e.code + ',errMessage:' + e.message);
}
getLocalDeviceType
getLocalDeviceType(): number;
Obtains the local device type.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Return value
Type | Description |
---|---|
number | Local device type obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
let deviceType: number = dmInstance.getLocalDeviceType();
console.log('local device type: ' + JSON.stringify(deviceType));
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getLocalDeviceType errCode:' + e.code + ',errMessage:' + e.message);
}
getLocalDeviceId
getLocalDeviceId(): string;
Obtains the local device ID.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Return value
Type | Description |
---|---|
string | Local device ID obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
let deviceId: string = dmInstance.getLocalDeviceId();
console.log('local device id: ' + JSON.stringify(deviceId));
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getLocalDeviceId errCode:' + e.code + ',errMessage:' + e.message);
}
getDeviceName
getDeviceName(networkId: string): string;
Obtains the device name based on the network ID of the specified device.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
networkId | string | Yes | Network ID of the device. |
Return value
Type | Description |
---|---|
string | Device name obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
// Network ID of the device, which can be obtained from the trusted device list.
let networkId = 'xxxxxxx';
let deviceName: string = dmInstance.getDeviceName(networkId);
console.log('device name: ' + JSON.stringify(deviceName));
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getDeviceName errCode:' + e.code + ',errMessage:' + e.message);
}
getDeviceType
getDeviceType(networkId: string): number;
Obtains the device type based on the network ID of the specified device.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
networkId | string | Yes | Network ID of the device. |
Return value
Type | Description |
---|---|
number | Device type obtained. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
// Network ID of the device, which can be obtained from the trusted device list.
let networkId = 'xxxxxxx';
let deviceType: number = dmInstance.getDeviceType(networkId);
console.log('device type: ' + JSON.stringify(deviceType));
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('getDeviceType errCode:' + e.code + ',errMessage:' + e.message);
}
startDiscovering
startDiscovering(discoverParam: {[key: string]: Object} , filterOptions?: {[key: string]: Object} ): void;
Starts to discover devices nearby. The discovery process lasts 2 minutes. A maximum of 99 devices can be discovered. In Wi-Fi scenarios, only the devices in the same LAN can be discovered.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
discoverParam | {[key: string]: Object} | Yes | Identifier of the device to discover. It specifies the type of the target to discover. discoverTargetType: The default discovery target is device. The value is 1. |
filterOptions | {[key: string]: Object} | No | Options for filtering the devices to discover. The default value is undefined, which means to discover offline devices. The options include the following: availableStatus(0-1): status of the device to discover. The value 0 means the device is untrusted. - 0: The device is offline. The client needs to call bindTarget to bind the device. - 1: The device is online and can be connected. discoverDistance(0-100): distance of the device to discover, in cm. This parameter is not used in Wi-Fi scenarios. authenticationStatus(0-1): authentication status of the device to discover. - 0: The device is not authenticated. - 1: The device has been authenticated. authorizationType(0-2): authorization type of the device to discover. - 0: The device is authenticated by a temporarily agreed session key. - 1: The device is authenticated by a key of the same account. - 2: The device is authenticated by a credential key of different accounts. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
11600104 | Discovery repeats. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
interface DiscoverParam {
discoverTargetType: number;
}
interface FilterOptions {
availableStatus: number;
discoverDistance: number;
authenticationStatus: number;
authorizationType: number;
}
let discoverParam: Record<string, number> = {
'discoverTargetType': 1
};
let filterOptions: Record<string, number> = {
'availableStatus': 0
};
try {
dmInstance.startDiscovering(discoverParam, filterOptions); // When devices are discovered, discoverSuccess is called to notify the application.
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('startDiscovering errCode:' + e.code + ',errMessage:' + e.message);
}
stopDiscovering
stopDiscovering(): void;
Stops device discovery.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
11600104 | Stop discovery repeats. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
dmInstance.stopDiscovering();
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('stopDiscovering errCode:' + e.code + ',errMessage:' + e.message);
}
bindTarget
bindTarget(deviceId: string, bindParam: {[key: string]: Object} , callback: AsyncCallback<{deviceId: string}>): void;
Binds a device.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | ID of the device to bind. |
bindParam | {[key: string]: Object} | Yes | Authentication parameters. You can determine the key-value pairs to be passed in. By default, the following keys are carried: bindType: binding type, which is mandatory. The values 2, 3, and 4 are embedded and are not supported currently. - 1: PIN. - 2: QR code. - 3: NFC. - 4: No interaction. targetPkgName: bundle name of the device to bind. appName: application that attempts to bind the device. appOperation: reason for the application to bind the device. customDescription: detailed description of the operation. |
callback | AsyncCallback<{deviceId: string, }> | Yes | Callback invoked to return the authentication result. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
11600103 | Bind invalid. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
class Data {
deviceId: string = '';
}
// Information about the device to authenticate. The information can be obtained from the device discovery result.
let deviceId = 'XXXXXXXX';
let bindParam: Record<string, string | number> = {
'bindType': 1, // Authentication type. The value 1 means PIN authentication.
'targetPkgName': 'xxxx',
'appName': 'xxxx',
'appOperation': 'xxxx',
'customDescription': 'xxxx'
};
try {
dmInstance.bindTarget(deviceId, bindParam, (err: BusinessError, data: Data) => {
if (err) {
console.error('bindTarget errCode:' + err.code + ',errMessage:' + err.message);
return;
}
console.info('bindTarget result:' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('bindTarget errCode:' + e.code + ',errMessage:' + e.message);
}
unbindTarget
unbindTarget(deviceId: string): void;
Unbinds a device.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. |
Error codes
For details about the error codes, see Device Management Error Codes.
ID | Error Message |
---|---|
11600101 | Failed to execute the function. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
let deviceId = 'XXXXXXXX';
dmInstance.unbindTarget(deviceId);
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('unbindTarget errCode:' + e.code + ',errMessage:' + e.message);
}
on('deviceStateChange')
on(type: 'deviceStateChange', callback: Callback<{ action: DeviceStateChange, device: DeviceBasicInfo }>): void;
Subscribes to device state changes. The application (identified by the bundle name) will be notified when the device state changes.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type. The value 'deviceStateChange' indicates device state changes. |
callback | Callback<{ action: DeviceStateChange, device: DeviceBasicInfo }> | Yes | Callback invoked to return the device information and state. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
class Data {
action: deviceManager.DeviceStateChange = 0;
device: deviceManager.DeviceBasicInfo = {
deviceId: '',
deviceName: '',
deviceType: '',
networkId: ''
};
}
try {
dmInstance.on('deviceStateChange', (data: Data) => {
console.info('deviceStateChange on:' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('deviceStateChange errCode:' + e.code + ',errMessage:' + e.message);
}
off('deviceStateChange')
off(type: 'deviceStateChange', callback?: Callback<{ action: DeviceStateChange, device: DeviceBasicInfo }>): void;
Unsubscribes from the device state changes.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type. The value 'deviceStateChange' indicates device state changes. |
callback | Callback<{ action: deviceStateChange, device: DeviceBasicInfo }> | No | Callback to unregister. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
class Data {
action: deviceManager.DeviceStateChange = 0;
device: deviceManager.DeviceBasicInfo = {
deviceId: '',
deviceName: '',
deviceType: '',
networkId: ''
};
}
try {
dmInstance.off('deviceStateChange', (data: Data) => {
console.info('deviceStateChange' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('deviceStateChange errCode:' + e.code + ',errMessage:' + e.message);
}
on('discoverSuccess')
on(type: 'discoverSuccess', callback: Callback<{ device: DeviceBasicInfo }>): void;
Subscribes to the 'discoverSuccess' event. The application will be notified when a device is successfully discovered.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of 'discoverSuccess'. |
callback | Callback<{ device: DeviceBasicInfo }> | Yes | Callback invoked when a device is successfully discovered. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
class Data {
device: deviceManager.DeviceBasicInfo = {
deviceId: '',
deviceName: '',
deviceType: '',
networkId: ''
};
}
try {
dmInstance.on('discoverSuccess', (data: Data) => {
console.info('discoverSuccess:' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('discoverSuccess errCode:' + e.code + ',errMessage:' + e.message);
}
off('discoverSuccess')
off(type: 'discoverSuccess', callback?: Callback<{ device: DeviceBasicInfo }>): void;
Unsubscribes from the 'discoverSuccess' event.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of 'discoverSuccess'. |
callback | Callback<{ device: DeviceBasicInfo }> | No | Callback to unregister. |
Example
import deviceManager from '@ohos.distributedDeviceManager';
import { BusinessError } from '@ohos.base';
class Data {
device: deviceManager.DeviceBasicInfo = {
deviceId: '',
deviceName: '',
deviceType: '',
networkId: ''
};
}
try {
dmInstance.off('discoverSuccess', (data: Data) => {
console.info('discoverSuccess' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('discoverSuccess errCode:' + e.code + ',errMessage:' + e.message);
}
on('deviceNameChange')
on(type: 'deviceNameChange', callback: Callback<{ deviceName: string }>): void;
Subscribes to device name changes. The application will be notified when the name of a device is changed.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of deviceNameChange. |
callback | Callback<{ deviceName: string}> | Yes | Callback invoked to return the device name change. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
class Data {
deviceName: string = '';
}
try {
dmInstance.on('deviceNameChange', (data: Data) => {
console.info('deviceNameChange on:' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('deviceNameChange errCode:' + e.code + ',errMessage:' + e.message);
}
off('deviceNameChange')
off(type: 'deviceNameChange', callback?: Callback<{ deviceName: string }>): void;
Unsubscribes from the device name changes.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of deviceNameChange. |
callback | Callback<{ deviceName: string}> | No | Callback to unregister. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
class Data {
deviceName: string = '';
}
try {
dmInstance.off('deviceNameChange', (data: Data) => {
console.info('deviceNameChange' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('deviceNameChange errCode:' + e.code + ',errMessage:' + e.message);
}
on('discoverFailure')
on(type: 'discoverFailure', callback: Callback<{ reason: number }>): void;
Subscribes to the 'discoverFailure' event. The application will be notified when a device fails to be discovered.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of 'discoverFailure'. |
callback | Callback<{ reason: number }> | Yes | Callback invoked when a device fails to be discovered. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
class Data {
reason: number = 0;
}
try {
dmInstance.on('discoverFailure', (data: Data) => {
console.info('discoverFailure on:' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('discoverFailure errCode:' + e.code + ',errMessage:' + e.message);
}
off('discoverFailure')
off(type: 'discoverFailure', callback?: Callback<{ reason: number }>): void;
Unsubscribes from the 'discoverFailure' event.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of 'discoverFailure'. |
callback | Callback<{ reason: number }> | No | Callback to unregister. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
class Data {
reason: number = 0;
}
try {
dmInstance.off('discoverFailure', (data: Data) => {
console.info('discoverFailure' + JSON.stringify(data));
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('discoverFailure errCode:' + e.code + ',errMessage:' + e.message);
}
on('serviceDie')
on(type: 'serviceDie', callback?: Callback<{}>): void;
Subscribes to the dead events of the DeviceManager service. The application will be notified when the DeviceManager service is terminated unexpectedly.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of 'serviceDie'. |
callback | Callback<{}> | No | Callback invoked when the DeviceManager service is terminated unexpectedly. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
dmInstance.on('serviceDie', () => {
console.info('serviceDie on');
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('serviceDie errCode:' + e.code + ',errMessage:' + e.message);
}
off('serviceDie')
off(type: 'serviceDie', callback?: Callback<{}>): void;
Unsubscribes from the dead events of the DeviceManager service.
Required permissions: ohos.permission.DISTRIBUTED_DATASYNC
System capability: SystemCapability.DistributedHardware.DeviceManager
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
type | string | Yes | Event type, which has a fixed value of 'serviceDie'. |
callback | Callback<{}> | No | Callback to unregister. |
Example
For details about how to initialize dmInstance in the example, see deviceManager.createDeviceManager.
import { BusinessError } from '@ohos.base';
try {
dmInstance.off('serviceDie', () => {
console.info('serviceDie off');
});
} catch (err) {
let e: BusinessError = err as BusinessError;
console.error('serviceDie errCode:' + e.code + ',errMessage:' + e.message);
}