Trees       Indices       Help   
conduit
Package conduit :: Package modules :: Package N800Module :: Module N800Module :: Class N800Base
[hide private]

Class N800Base

source code

TwoWay dataprovider for synchronizing a folder on a N800

Instance Methods [hide private]
 
__init__(self, mount, udi, folder)
All sync functionality should be provided by derived classes		 source code
 
configure(self, window)
Show a configuration box for configuring the dataprovider instance.		 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_input_conversion_args(self)
Provides a way to pass arguments to conversion functions.		 source code
dict(string)
get_configuration(self)
Returns a dictionary of strings to be saved, representing the dataproviders current configuration.		 source code
string
get_UID(self)
Returns a UID that represents this dataproviders (locally) unique state and configuration.		 source code

Inherited from dataproviders.File.FolderTwoWay: add, delete, finish, get, get_all, initialize, is_configured, put

Inherited from dataproviders.File.FolderTwoWay (private): _transfer_file

Inherited from dataproviders.DataProvider.DataSource: get_changes, get_num_items

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

Class Variables [hide private]
  DEFAULT_FOLDER = _("Conduit")
  FORMAT_CONVERSION_STRING = _("%s Format (%s)")
  NO_CONVERSION_STRING = _("unchanged")
  _configurable_ = True

Inherited from dataproviders.File.FolderTwoWay: _category_, _icon_, _in_type_, _module_type_, _out_type_

Inherited from dataproviders.DataProvider.DataProviderBase: __gsignals__, _description_, _name_

Method Details [hide private]

__init__(self, mount, udi, folder)
(Constructor)

source code 
All sync functionality should be provided by derived classes
Overrides: dataproviders.File.FolderTwoWay.__init__

configure(self, window)

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

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.File.FolderTwoWay.refresh

get_input_conversion_args(self)

source code 
Provides a way to pass arguments to conversion functions. For example when transcoding a music file the dataprovider may return a dictionary specifying the conversion encoding, quality, etc
Returns:
a dict of conversion arguments
Overrides: dataproviders.DataProvider.DataProviderBase.get_input_conversion_args
(inherited documentation)

get_configuration(self)

source code 
Returns a dictionary of strings to be saved, representing the dataproviders current configuration. Should be overridden by all dataproviders wishing to be able to save their state between application runs
Returns: dict(string)
Dictionary of strings containing application settings
Overrides: dataproviders.DataProvider.DataProviderBase.get_configuration
(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)

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