sbIDeviceManager Interface Reference

import"sbIDeviceManager.idl";

Inheritance diagram for sbIDeviceManager:
[legend]
Collaboration diagram for sbIDeviceManager:
[legend]

Public Member Functions

AString getCategoryByIndex (in PRUint32 aIndex)
 
sbIDeviceBase getDeviceByIndex (in PRUint32 aIndex)
 
PRBool hasDeviceForCategory (in AString aCategory)
 
sbIDeviceBase getDeviceByCategory (in AString aCategory)
 

Public Attributes

readonly attribute PRUint32 deviceCount
 

Detailed Description

This is the DeviceManager service. Make sure to use getService rather than createInstance when using.

Note
Implementations of this interface must be threadsafe.

This is the DeviceManager service. Make sure to use getService rather than createInstance when using.

Definition at line 36 of file sbIDeviceManager.idl.

Member Function Documentation

AString sbIDeviceManager::getCategoryByIndex ( in PRUint32  aIndex)

Gets the category of the device at the specified index

Parameters
aIndex- the index of the device
Exceptions
NS_ERROR_INVALID_INDEXif the index is > deviceCount
sbIDeviceBase sbIDeviceManager::getDeviceByCategory ( in AString  aCategory)

Returns a registered and initialized device.

Parameters
aCategory- a category string identifying the device
Exceptions
NS_ERROR_NOT_AVAILABLEif no device exists to handle the category.
NS_ERROR_UNEXPECTEDif the internal array returns garbage
sbIDeviceBase sbIDeviceManager::getDeviceByIndex ( in PRUint32  aIndex)

Returns a registered and initialized device at the specified index

Parameters
aIndex- the index of the device
Exceptions
NS_ERROR_INVALID_INDEXif the index is > deviceCount
PRBool sbIDeviceManager::hasDeviceForCategory ( in AString  aCategory)

Determines whether or not a device exists for the given category.

Parameters
aCategory- a category string to test

Member Data Documentation

readonly attribute PRUint32 sbIDeviceManager::deviceCount

The number of devices currently registered

Definition at line 41 of file sbIDeviceManager.idl.


The documentation for this interface was generated from the following file: