Package conduit :: Package modules :: Package iPodModule :: Module iPodModule :: Class IPodPhotoSink
[hide private]

Class IPodPhotoSink

source code


Instance Methods [hide private]
 
__init__(self, *args)
All sync functionality should be provided by derived classes
source code
 
_set_sysinfo(self, modelnumstr, model) source code
 
_get_photo_album(self, albumName) source code
 
_create_photo_album(self, albumName) source code
 
_get_photo_by_id(self, id) source code
 
_delete_album(self, albumName) source code
 
_empty_all_photos(self) source code
 
_get_photo_albums(self) source code
 
refresh(self)
Performs any (conduit.logging in, etc) which must be undertaken on the dataprovider prior to calling get_all().
source code
 
get_all(self)
Returns an array of all the LUIDs this dataprovider holds.
source code
 
put(self, f, overwrite, LUID=None)
Stores data.
source code
 
delete(self, LUID)
Deletes data with LUID.
source code
 
configure(self, window)
Show a configuration box for configuring the dataprovider instance.
source code
 
is_configured(self, isSource, isTwoWay)
Checks if the dp has been configured or not (and if it needs to be)
source code
 
uninitialize(self)
Called just before the application quits.
source code

Inherited from IPodBase: finish, get_UID

Inherited from IPodBase (private): _get_unique_filename

Inherited from dataproviders.DataProvider.DataSource: add, get, get_changes, get_num_items

Inherited from dataproviders.DataProvider.DataProviderBase: emit, emit_change_detected, get_configuration, get_configuration_xml, get_input_conversion_args, get_input_type, get_name, get_output_conversion_args, get_output_type, get_status, initialize, is_busy, set_configuration, set_configuration_xml, set_status

Class Variables [hide private]
  _name_ = "Photos"
  _description_ = "Sync your iPod photos"
  _module_type_ = "sink"
  _in_type_ = "file/photo"
  _out_type_ = "file/photo"
  _icon_ = "image-x-generic"
  _configurable_ = True
  SAFE_PHOTO_ALBUM = "Photo Library"

Inherited from dataproviders.DataProvider.DataProviderBase: __gsignals__, _category_

Method Details [hide private]

__init__(self, *args)
(Constructor)

source code 
All sync functionality should be provided by derived classes
Overrides: IPodBase.__init__

refresh(self)

source code 

Performs any (conduit.logging in, etc) which must be undertaken on the dataprovider prior to calling get_all(). Should gather all information so a subsequent call to get_all() can return the uids of all the data this dataprovider holds

This function may be called multiple times so derived classes should be aware of this.

Derived classes should call this function to ensure the dataprovider status is updated.
Overrides: IPodBase.refresh

get_all(self)

source code 
Returns an array of all the LUIDs this dataprovider holds.
Overrides: IPodBase.get_all

put(self, f, overwrite, LUID=None)

source code 

Stores data. The derived class is responsible for checking if putData conflicts.

In the case of a two-way datasource, the derived type should consider the overwrite parameter, which if True, should allow the dp to replace a datatype instance if one is found at the existing location

Derived classes should call this function to ensure the dataprovider status is updated.
Overrides: dataproviders.DataProvider.DataSink.put
(inherited documentation)

delete(self, LUID)

source code 
Deletes data with LUID.
Overrides: IPodBase.delete

configure(self, window)

source code 
Show a configuration box for configuring the dataprovider instance.
Overrides: dataproviders.DataProvider.DataProviderBase.configure
(inherited documentation)

is_configured(self, isSource, isTwoWay)

source code 
Checks if the dp has been configured or not (and if it needs to be)
Overrides: dataproviders.DataProvider.DataProviderBase.is_configured
(inherited documentation)

uninitialize(self)

source code 
Called just before the application quits.
Overrides: dataproviders.DataProvider.DataProviderBase.uninitialize
(inherited documentation)