Trees       Indices       Help   
conduit
Package conduit :: Package modules :: Package iPodModule :: Module iPodModule :: Class IPodBase
[hide private]

Class IPodBase

source code

Instance Methods [hide private]
 
__init__(self, *args)
All sync functionality should be provided by derived classes		 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
 
delete(self, LUID)
Deletes data with LUID.		 source code
 
finish(self, aborted, error, conflict)
Perform any post-sync cleanup.		 source code
string
get_UID(self)
Returns a UID that represents this dataproviders (locally) unique state and configuration.		 source code
 
_get_unique_filename(self, directory)
Returns the name of a non-existant file on the ipod within directory		 source code

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

Inherited from dataproviders.DataProvider.DataProviderBase: configure, 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, is_configured, set_configuration, set_configuration_xml, set_status, uninitialize

Inherited from dataproviders.DataProvider.DataSink: put

Class Variables [hide private]

Inherited from dataproviders.DataProvider.DataProviderBase: __gsignals__, _category_, _configurable_, _description_, _icon_, _in_type_, _module_type_, _name_, _out_type_

Method Details [hide private]

__init__(self, *args)
(Constructor)

source code 
All sync functionality should be provided by derived classes
Overrides: dataproviders.DataProvider.TwoWay.__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: dataproviders.DataProvider.DataProviderBase.refresh
(inherited documentation)

get_all(self)

source code 
Returns an array of all the LUIDs this dataprovider holds.
Overrides: dataproviders.DataProvider.DataSource.get_all
(inherited documentation)

delete(self, LUID)

source code 
Deletes data with LUID.
Overrides: dataproviders.DataProvider.DataSink.delete
(inherited documentation)

finish(self, aborted, error, conflict)

source code 
Perform any post-sync cleanup. For example, free any structures created in refresh that were used in the synchronization.
Overrides: dataproviders.DataProvider.DataProviderBase.finish
(inherited documentation)

get_UID(self)

source code 

Returns a UID that represents this dataproviders (locally) unique state and configuration. For example the LUID for a gmail dp may be your username and password.

Derived types MUST overwride this function
Returns: string
Overrides: dataproviders.DataProvider.DataProviderBase.get_UID
(inherited documentation)

_get_unique_filename(self, directory)

source code 
Returns the name of a non-existant file on the ipod within directory
Parameters:
  • directory - Name of the directory within the device root to make the random file in

   Trees       Indices       Help   
conduit
Generated by Epydoc 3.0beta1 on Sat Aug 2 22:18:37 2008 http://epydoc.sourceforge.net