Methods, available from within Plugin object:
name |
getUrl |
description |
Gets url for standalone plugin page (example.com/plugin/MyTestPlugin) |
parameters |
none |
returns |
string |
name |
Inline |
description |
Gets executed when plugin is displayed inside existing page DOM. Here, for instance you can generate a button or a link that will then be attached to a page, using JS. See sample plugins for more info. (see displaying plugin) |
parameters |
none |
returns |
void |
name |
standalone |
description |
Gets executed when plugin is displayed on standalone page or used as substitution for existing page contents (see displaying plugin) |
parameters |
none |
returns |
void |
name |
getSetting |
description |
Gets setting value from plugins configuration |
parameters |
title (string): setting title from plugin configuration file |
returns |
mixed |
name |
callPortal |
description |
Makes portalDI call, using Elegant 6 API. |
parameters |
action (string): portalDI action name. The following actions are available: |
|
fileinfo |
|
showdirinfo |
|
browse |
|
search |
|
showusersettings |
|
showbasket |
|
getimage |
|
showkywdperms |
|
showvols |
|
submitkywd |
|
getorderimage |
|
streamfile |
|
filemgr |
|
preferredspread |
|
addbasket |
|
showbaskbtns |
|
clearbasket |
|
removebasket |
|
version |
|
upload |
|
saveannotations |
|
navigator |
|
presearch |
|
Actions available for webnative v.18 or higher: |
|
comments |
|
save_comment |
|
delete_comment |
|
user |
|
getParams = null (array null): array or key – value pairs, that will be attached to portalDI call as $_GET parameters. |
|
postParams = null (array null): array of key – value pairs, that will be attached to portalDI call as $_POST parameters |
|
See portalDI documentation for more info on actions and parameters they support |
|
See sample plugins for more info on method usage |
returns |
mixed |
You are free to add any additional methods that are needed for your own plugin implementation.
See sample PreviewPlugin and CustomViewPlugin source code for more details.