程序包 ohos.distributedhardware.devicemanager

类 DeviceManager

java.lang.Object

ohos.distributedhardware.devicemanager.DeviceManager

public class DeviceManager
extends Object

Provides methods for managing devices, including the methods for querying information about local and trusted devices, subscribing to device online and offline notifications, and obtaining devices selected by users.

You can call getLocalDeviceInfo() to query basic information about a local device.

After trusted devices have been networked, getTrustedDeviceList(java.lang.String,java.util.Map) can be called to obtain the trusted device list.

You can call registerDeviceStateCallback(java.lang.String,java.util.Map,ohos.distributedhardware.devicemanager.DeviceStateCallback) to register device state callbacks to listen for state changes of a device. When a trusted device goes online or offline, the particular callback defined in DeviceStateCallback will be called to notify your application of the online or offline device information.

If your application no longer needs to be notified of device state changes, you can call unregisterDeviceStateCallback(java.lang.String,ohos.distributedhardware.devicemanager.DeviceStateCallback) to unregister all previously registered callbacks to stop listening for state changes of a trusted device.

After selectDeviceList(java.lang.String,java.util.Map,ohos.distributedhardware.devicemanager.SelectDeviceListListener) is called, the list of available devices will be displayed on the screen for the user to select. After the user chooses a desired device, SelectDeviceListListener will be triggered to notify your application of the information and state of the selected device.

从以下版本开始:

4

嵌套类概要

嵌套类

限定符和类型	类	说明
static interface	DeviceManager.DeviceManagerCallback	Provides callbacks for getting DeviceManager instance.

字段概要

字段

限定符和类型	字段	说明
static String	SIFT_FILTER	Indicates the field name for the filtering parameter.
static String	SORT_TYPE	Indicates the field name for the sorting type.
static String	TARGET_PACKAGE_NAME	Indicates the field name for the target application bundle name.

方法概要

限定符和类型	方法	说明
static int	createInstance(DeviceManager.DeviceManagerCallback callback)	Creates a DeviceManager instance.
DeviceInfo	getLocalDeviceInfo()	Obtains the local device information.
List<DeviceInfo>	getTrustedDeviceList(String bundleName, Map<String,Object> extras)	Obtains a list of trusted devices.
int	registerDeviceStateCallback(String bundleName, Map<String,Object> extras, DeviceStateCallback callback)	Registers a device state callback so that the application can be notified upon device state changes based on the application bundle name and filtering parameter.
static void	releaseInstance()	Releases the DeviceManager instance after the methods for device management are no longer used.
int	selectDeviceList(String bundleName, Map<String,Object> extras, SelectDeviceListListener listener)	Presents the candidate device list on the UI for the user to select and notifies the application of the selected device.
int	unregisterDeviceStateCallback(String bundleName, DeviceStateCallback callback)	Unregisters the device state callback.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

SIFT_FILTER

public static final String SIFT_FILTER

Indicates the field name for the filtering parameter.

从以下版本开始:

4

另请参阅:

常量字段值

SORT_TYPE

public static final String SORT_TYPE

Indicates the field name for the sorting type.

If this field is not specified during device query, the devices are not sorted by default. In this case, SIFT_FILTER must be specified.

• The following sorting types are supported:
• 0: Most recently used (MRU)
• 1: Most frequently used (MFU)
• 2: AI mode. Currently, it is implemented by the combination of MRU and MFU. (The top 1 device is sorted using MRU, and top 2 to top N are sorted using MFU based on the number of times that a device is selected.)

从以下版本开始:

4

另请参阅:

常量字段值

TARGET_PACKAGE_NAME

public static final String TARGET_PACKAGE_NAME

Indicates the field name for the target application bundle name.

If this field is specified during trusted device query, application-level trusted devices are filtered to ensure that the specified application is in the group of application-level trusted devices and a list containing both device- and application-level trusted devices will be returned. If this field is not specified, only a list of device-level trusted devices will be provided. Device-level trusted devices include devices with the same account or those with different accounts but in the public group.

从以下版本开始:

4

另请参阅:

常量字段值

方法详细资料

createInstance

public static int createInstance(DeviceManager.DeviceManagerCallback callback)

Creates a DeviceManager instance.

To manage devices, you must first call this method to obtain a DeviceManager instance and then use this instance to call other device management methods.

参数:

callback - Indicates the callback to be invoked upon DeviceManager instance creation. The instance will be carried in DeviceManagerCallback#onGet(DeviceManager) after being created, and your application will be notified via DeviceManagerCallback#onDied() if the instance is destroyed.

返回:

Returns the instance creation result. For details, see ReturnCode.

从以下版本开始:

4

releaseInstance

public static void releaseInstance()

Releases the DeviceManager instance after the methods for device management are no longer used.

从以下版本开始:

4

getTrustedDeviceList

public List<DeviceInfo> getTrustedDeviceList(String bundleName,
                                             Map<String,Object> extras)
                                      throws SecurityException

Obtains a list of trusted devices.

参数:

bundleName - Indicates the bundle name of the application.

extras - Indicates the extra parameters to be passed to this method for device filtering or sorting. This parameter can be null. For details about available values, see TARGET_PACKAGE_NAME and SORT_TYPE.

返回:

Returns a list of trusted devices.

抛出:

SecurityException - Throws this exception if the application does not have the required permission.

从以下版本开始:

4

selectDeviceList

public int selectDeviceList(String bundleName,
                            Map<String,Object> extras,
                            SelectDeviceListListener listener)
                     throws SecurityException

Presents the candidate device list on the UI for the user to select and notifies the application of the selected device.

参数:

bundleName - Indicates the bundle name of the application.

extras - Indicates the extra parameters to be passed to this method for device filtering or sorting. This parameter cannot be null. For details about available values, see TARGET_PACKAGE_NAME, SORT_TYPE, and SIFT_FILTER.

listener - Indicates the callback invoked for notifying the application of the selected device and its state. For details, see SelectDeviceListListener.

返回:

Returns the device selection result. For details, see ReturnCode.

抛出:

SecurityException - Throws this exception if the application does not have the required permission.

从以下版本开始:

4

getLocalDeviceInfo

public DeviceInfo getLocalDeviceInfo()
                              throws SecurityException

Obtains the local device information.

返回:

Returns the DeviceInfo object containing the local device information.

抛出:

SecurityException - Throws this exception if the application does not have the required permission.

从以下版本开始:

4

registerDeviceStateCallback

public int registerDeviceStateCallback(String bundleName,
                                       Map<String,Object> extras,
                                       DeviceStateCallback callback)
                                throws SecurityException

Registers a device state callback so that the application can be notified upon device state changes based on the application bundle name and filtering parameter.

参数:

bundleName - Indicates the bundle name of the application.

extras - Indicates the extra parameters to be passed to this method for device filtering or sorting. This parameter can be null. For details about available values, see TARGET_PACKAGE_NAME and SIFT_FILTER.

callback - Indicates the device state callback to register. For details, see DeviceStateCallback.

返回:

Returns the registration result of the device state callback. For details, see ReturnCode.

抛出:

SecurityException - Throws this exception if the application does not have the required permission.

从以下版本开始:

4

unregisterDeviceStateCallback

public int unregisterDeviceStateCallback(String bundleName,
                                         DeviceStateCallback callback)
                                  throws SecurityException

Unregisters the device state callback.

参数:

bundleName - Indicates the bundle name of the application.

callback - Indicates the device state callback to unregister. For details, see DeviceStateCallback.

返回:

Returns the unregistration result of the device state callback. For details, see ReturnCode.

抛出:

SecurityException - Throws this exception if the application does not have the required permission.

从以下版本开始:

4