Login Plugins
Last updated
Was this helpful?
Last updated
Was this helpful?
Login Plugins mostly play a support role: They can be called by all other plugins: Metadata, Downloader and Script Plugins. Their role is to provide a configured object that can be used to perform authenticated operations on a remote Web service.
Only one subroutine needs to be implemented for the module to be recognized: do_login
, which contains your working code. You're free to implement other subroutines for cleaner code, of course.
When executing your Plugin, LRR will call the do_login
subroutine and give it the following variables:
The $params
hash contains the values of the user defined parameters.
Your plugin must return a object. That's it!
There's no particular error handling for Login Plugins at the moment, so I recommend you return an empty UserAgent if Login fails and handle the error in the matching Metadata/Script plugin.
If you have a plugin that you want to convert to using named parameters check in the section.