File FtpExport.lua
Functions
FtpExport.endDialog (props, why) | Called when dialog box is closing. |
FtpExport.processRenderedPhotos (functionContext, exportContext) | Called to process render(ing) photos. |
FtpExport.propertyChangeHandler (id, props, name, value) | FtpExport parameter change handler proper - static function |
FtpExport.sectionsForBottomOfDialog (vf, props) | Presently, there are no default sections imagined for the export bottom. |
FtpExport.sectionsForTopOfDialog (vf, props) | Presently, it is imagined to just replicate the manager's top section in the export. |
FtpExport.startDialog (props) | Called when dialog box is opening - static function as required by Lightroom. |
FtpExport:_getServiceName (props) | get fully qualified (unique) service name based on properties. |
FtpExport:checkBeforeRendering () | Remove photos not to be rendered, or whatever. |
FtpExport:endDialogMethod (props, why) | Do whatever when dialog box closing. |
FtpExport:finale (service) | Perform export service wrap-up. |
FtpExport:initiate (service) | Called when export is initiated. |
FtpExport:newClass (t) | Constructor for extending class. |
FtpExport:newDialog (t) | Constructor to create the export object that represents the export dialog box. |
FtpExport:newExport (t) | Create a new export object. |
FtpExport:newFtpJob () | Called when new export is getting under way (i.e. |
FtpExport:processRenderedPhoto (rendition, photoPath) | Process one rendered photo. |
FtpExport:processRenderedPhotosMethod () | Method version of like-named static function. |
FtpExport:processRenderingFailure (rendition, message) | Process one photo rendering failure. |
FtpExport:propertyChangeHandlerMethod (props, name, value) | Handle change to properties under authority of base export class. |
FtpExport:sectionsForBottomOfDialogMethod (vf, props) | Standard export sections for bottom of dialog. |
FtpExport:sectionsForTopOfDialogMethod (vf, props) | Standard export sections for top of dialog. |
FtpExport:service (service) | Service function of base export - processes renditions. |
FtpExport:startDialogMethod (props) | Do whatever when dialog box opening. |
Functions
- FtpExport.endDialog (props, why)
-
Called when dialog box is closing.
Parameters:
-
props
: -
why
:
Usage:
Generally no reason to override in derived class - override method instead.
Just calls corresponding method of actual (i.e derived class) export object.
-
- FtpExport.processRenderedPhotos (functionContext, exportContext)
-
Called to process render(ing) photos.
Photos have not started rendering when this is first called. Once started, they will be rendered in an asynchronous task within Lightroom. Rendering may be started implicitly by invoking the renditions iterator of the export context, or explicitly by calling export-context - start-rendering.
Parameters:
-
functionContext
: -
exportContext
:
Usage:
Generally no reason to override in derived class - override method instead.
1st: creates derived export object via object factory,
then calls corresponding method of actual (i.e derived class) export object.Rendering order is not guaranteed, however experience dictates they are in order.
-
- FtpExport.propertyChangeHandler (id, props, name, value)
-
FtpExport parameter change handler proper - static function
Parameters:
-
id
: -
props
: -
name
: -
value
:
Usage:
Generally no reason to override in derived class - override method instead.
Just calls corresponding method of actual (i.e derived class) export object.
-
- FtpExport.sectionsForBottomOfDialog (vf, props)
-
Presently, there are no default sections imagined for the export bottom.
Parameters:
-
vf
: -
props
:
Usage:
Generally no reason to override in derived class - override method instead.
Just calls corresponding method of actual (i.e derived class) export dialog object.
-
- FtpExport.sectionsForTopOfDialog (vf, props)
-
Presently, it is imagined to just replicate the manager's top section in the export.
Parameters:
-
vf
: -
props
:
Usage:
Generally no reason to override in derived class - override method instead.
Just calls corresponding method of actual (i.e derived class) export dialog object.
-
- FtpExport.startDialog (props)
-
Called when dialog box is opening - static function as required by Lightroom.
Parameters:
-
props
:
Usage:
Generally no reason to override in derived class - override method instead.
Just calls corresponding method of actual (i.e derived class) export object.
-
- FtpExport:_getServiceName (props)
-
get fully qualified (unique) service name based on properties.
Parameters:
-
props
:
Usage:
*** critical side effect: service name will be assigned to properties *if* not publish service properties.
*** to be clear: do NOT assign the output of this to service-name property, since it includes app-name prefix.
-
- FtpExport:checkBeforeRendering ()
- Remove photos not to be rendered, or whatever.
- FtpExport:endDialogMethod (props, why)
-
Do whatever when dialog box closing.
Nuthin yet...
Parameters:
-
props
: -
why
:
Usage:
Call from derived class to ensure dialog is ended properly according to base class.
-
- FtpExport:finale (service)
-
Perform export service wrap-up.
Parameters:
-
service
:
Usage:
Override this method in derived class to log stats...
*** IMPORTANT: This method is critical to export integrity. Derived export class must remember to call it at end of special export finale method.
-
- FtpExport:initiate (service)
-
Called when export is initiated.
Parameters:
-
service
:
Usage:
This method helps export manager track managed exports (all exports based on this class are managed).
-
- FtpExport:newClass (t)
-
Constructor for extending class.
Parameters:
-
t
:
-
- FtpExport:newDialog (t)
-
Constructor to create the export object that represents the export dialog box.
One of these objects is created when the export dialog box is presented, if it has not already been.
Parameters:
-
t
:
-
- FtpExport:newExport (t)
-
Create a new export object.
One of these objects is created EACH time a new export is initiated, then killed at export completion - supports multiple concurrent exports, without interference (assuming a different set of photos is selected, otherwise all kinds of interference...)
Parameters:
-
t
: Parameter table- exportContext
- functionContext
Return value:
- FtpExport object
-
- FtpExport:newFtpJob ()
- Called when new export is getting under way (i.e. early in process-rendered-photos func/meth). It makes sure the appropriate directory infrastructure exists, and ascertains the correct job-num to use.
- FtpExport:processRenderedPhoto (rendition, photoPath)
-
Process one rendered photo.
Parameters:
-
rendition
: -
photoPath
:
-
- FtpExport:processRenderedPhotosMethod ()
-
Method version of like-named static function.
Usage:
Same as base-class method, except pre-init ftp job.
Note: ftp-export needs special finale logic too (to close ftp job) - not handled in this method, since it needs to weather thrown errors.
- FtpExport:processRenderingFailure (rendition, message)
-
Process one photo rendering failure.
Parameters:
-
rendition
: -
message
: error message generated by Lightroom.
-
- FtpExport:propertyChangeHandlerMethod (props, name, value)
-
Handle change to properties under authority of base export class.
Presently there are none - but that could change
Parameters:
-
props
: -
name
: -
value
:
Usage:
Call from derived class to ensure base property changes are handled.
-
- FtpExport:sectionsForBottomOfDialogMethod (vf, props)
-
Standard export sections for bottom of dialog.
Reminder: Lightroom supports named export presets.
Parameters:
-
vf
: -
props
:
Usage:
These sections can be combined with derived class's in their entirety, or strategically - presently there are none.
-
- FtpExport:sectionsForTopOfDialogMethod (vf, props)
-
Standard export sections for top of dialog.
Presently seems like a good idea to replicate the plugin manager sections.
Parameters:
-
vf
: -
props
:
Usage:
These sections can be combined with derived class's in their entirety, or strategically...
-
- FtpExport:service (service)
-
Service function of base export - processes renditions.
You can override this method in its entirety, OR just:
- checkBeforeRendering
- processRenderedPhoto
- processRenderingFailure
- (and finale maybe)
Parameters:
-
service
:
- FtpExport:startDialogMethod (props)
-
Do whatever when dialog box opening.
Nuthin to do so far - but that could change.
Parameters:
-
props
:
Usage:
Call from derived class to ensure dialog is initialized according to base class.
-