Class PluginInterface

object --+
         |
        PluginInterface

The base class to all plugins. For writing plugins inherit from this class and set the appropriate values for your plugin:

name: friendly name for your plugin. All objects inside your plugin will be named in the form name:id.
usage: can be on or off. This value is automatically set when your plugin has an entry on the configuration file. When set to 'off', the plugin manager will not instantiate the plugin.
has_browse_filter: can be True or False. If your plugin implements the browse() function in a way that it uses the slicing/sorting (filters) parameters, has_browse_filter should be set to True. If not, it should be False (which means that the filter will be applied by the plugin manager - your plugin returns browse result).

Instance Methods

[hide private]

__init__(self, *args, **kwargs)
Initializes the base plugin.

source code

execute(self)
Loads the plugin media information into the database.

source code

load(self)
Forces subclasses to implement the load method.

source code

publish(self, webserver)
Publishes the plugin resources on the service's webserver.

source code

unload(self)
Unloads the plugin media information from memory.

source code

string

browse(self, str_object_id, browse_flag, filter, starting_index, requested_count, sort_criteria)
Browse implementation for the plugin.

source code

string

search(self, str_object_id, browse_flag, filter, starting_index, requested_count, sort_criteria)
Search implementation for the plugin.

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__