Package rosh :: Module plugin :: Class PluginData

Class PluginData

object --+
         |
        PluginData

Instance Methods

__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

add_handler(self, plugin_api_id, args)

source code

add_api(self, plugin_api_id, callback)
Register plugin API that downstream plugins can add handlers for.

source code

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

Properties
Inherited from `object`: `__class__`

Method Details

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

add_handler(self, plugin_api_id, args)

source code

Parameters:

plugin_api_id (str) - identifier for API to register with
args ([any]) - arguments for plugin API

add_api(self, plugin_api_id, callback)

source code

Parameters:

plugin_api_id (str) - identifier for this API
callback (fn) - callback function to invoke when handlers register with this API

Class PluginData

__init__(self) (Constructor)

add_handler(self, plugin_api_id, args)

add_api(self, plugin_api_id, callback)

init(self)
(Constructor)