sbIDeviceErrorMonitor Interface Reference

This service monitors devices for errors and stores them for easy access later. More...

import"sbIDeviceErrorMonitor.idl";

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

Public Member Functions

boolean deviceHasErrors (in sbIDevice aDevice, in AString aContentType, in unsigned long aDirection)
 Checks to see if a device has had any recent errors. More...
 
nsIArray getDeviceErrors (in sbIDevice aDevice, [optional] in AString aContentType, [optional] in unsigned long aDirection)
 Gets an array of property bags containing information about the errors. More...
 
void clearErrorsForDevice (in sbIDevice aDevice)
 Clears the array of error strings for a device. More...
 
void addListener (in sbIDeviceErrorMonitorListener aListener)
 Adds a listener for new device errors. More...
 
void removeListener (in sbIDeviceErrorMonitorListener aListener)
 Removes a listener for new device errors. More...
 

Detailed Description

This service monitors devices for errors and stores them for easy access later.

Definition at line 44 of file sbIDeviceErrorMonitor.idl.

Member Function Documentation

void sbIDeviceErrorMonitor::addListener ( in sbIDeviceErrorMonitorListener  aListener)

Adds a listener for new device errors.

Parameters
aListenerlistener to call when a device error is logged.
void sbIDeviceErrorMonitor::clearErrorsForDevice ( in sbIDevice  aDevice)

Clears the array of error strings for a device.

Parameters
aDevicedevice to clear error list from.
boolean sbIDeviceErrorMonitor::deviceHasErrors ( in sbIDevice  aDevice,
in AString  aContentType,
in unsigned long  aDirection 
)

Checks to see if a device has had any recent errors.

Parameters
aDevicedevice to check for errors on.
aContentTypetype of content we want to check for errors on. This may be blank in which case errors returned are not filtered by content type.
aDirectionsbIDeviceStatus.[EXPORT|IMPORT] or this may be 0 and errors returned are not filtered based on direction.
Returns
true if any errors are currently registered for this device.
nsIArray sbIDeviceErrorMonitor::getDeviceErrors ( in sbIDevice  aDevice,
[optional] in AString  aContentType,
[optional] in unsigned long  aDirection 
)

Gets an array of property bags containing information about the errors.

Parameters
aDeviceThe device to get the list of errors for
aContentTypetype of content we want errors for, or empty string for all types.
aDirectionsbIDeviceStatus.[EXPORT|IMPORT]
Returns
array of property bags that contain error information

The property bag currently contains msg and state for the error message and device state respectively

void sbIDeviceErrorMonitor::removeListener ( in sbIDeviceErrorMonitorListener  aListener)

Removes a listener for new device errors.

Parameters
aListenerlistener to remove.

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