Public Member Functions | Public Attributes | List of all members
sbIDeviceStatus Interface Reference

import"sbIDeviceStatus.idl";

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

Public Member Functions

void init (in AString aDeviceID)
 Initialize the DeviceStatus component for a device. More...
 

Public Attributes

const unsigned long EXPORT = 1
 
const unsigned long IMPORT = 2
 
attribute unsigned long currentState
 The current overall state of the device. More...
 
attribute unsigned long currentSubState
 The current sub state of the device, copying could be a sub state of the syncing state. More...
 
attribute AString stateMessage
 
attribute AString currentOperation
 
attribute double progress
 
attribute PRInt64 workItemProgress
 
attribute PRInt32 workItemType
 
attribute PRInt64 workItemProgressEndCount
 
attribute sbIMediaItem mediaItem
 
readonly attribute PRUint32 elapsedTime
 The time elapsed in milliseconds since currentState was last at STATE_IDLE. More...
 
attribute sbIMediaList mediaList
 
attribute boolean isNewBatch
 

Detailed Description

Note
Implementations of this interface must be threadsafe.

Holds the current status of a device, idle, syncing, etc with all the relevent information.

Definition at line 44 of file sbIDeviceStatus.idl.

Member Function Documentation

void sbIDeviceStatus::init ( in AString  aDeviceID)

Initialize the DeviceStatus component for a device.

Member Data Documentation

attribute AString sbIDeviceStatus::currentOperation

Sets the current operation

Definition at line 70 of file sbIDeviceStatus.idl.

attribute unsigned long sbIDeviceStatus::currentState

The current overall state of the device.

See Also
sbIDevice::STATE_*

Definition at line 53 of file sbIDeviceStatus.idl.

attribute unsigned long sbIDeviceStatus::currentSubState

The current sub state of the device, copying could be a sub state of the syncing state.

See Also
sbIDevice::STATE_*

Definition at line 60 of file sbIDeviceStatus.idl.

readonly attribute PRUint32 sbIDeviceStatus::elapsedTime

The time elapsed in milliseconds since currentState was last at STATE_IDLE.

These are for showing an estimated time of completion for an operation, like copying, transcoding, etc. Generally it will be for a single item operation, like copying a file to the device.

Definition at line 106 of file sbIDeviceStatus.idl.

const unsigned long sbIDeviceStatus::EXPORT = 1

Definition at line 47 of file sbIDeviceStatus.idl.

const unsigned long sbIDeviceStatus::IMPORT = 2

Definition at line 48 of file sbIDeviceStatus.idl.

attribute boolean sbIDeviceStatus::isNewBatch

A new batch has begun since you last checked

Definition at line 116 of file sbIDeviceStatus.idl.

attribute sbIMediaItem sbIDeviceStatus::mediaItem

Current Item being processed

Definition at line 95 of file sbIDeviceStatus.idl.

attribute sbIMediaList sbIDeviceStatus::mediaList

Current List being processed

Definition at line 111 of file sbIDeviceStatus.idl.

attribute double sbIDeviceStatus::progress

Sets the current progress as a percent. Done is 1.0.

Definition at line 75 of file sbIDeviceStatus.idl.

attribute AString sbIDeviceStatus::stateMessage

Sets the state message

Definition at line 65 of file sbIDeviceStatus.idl.

attribute PRInt64 sbIDeviceStatus::workItemProgress

Sets the current work item # for example processing multiple files

Definition at line 80 of file sbIDeviceStatus.idl.

attribute PRInt64 sbIDeviceStatus::workItemProgressEndCount

Sets the end count for processing multiple items

Definition at line 90 of file sbIDeviceStatus.idl.

attribute PRInt32 sbIDeviceStatus::workItemType

Sets the current work item type

Definition at line 85 of file sbIDeviceStatus.idl.

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