| $ABORT |
| function $abort |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade for cfabort |
| Description: |
|
|
|
| $DUMP |
| function $dump |
Arguments:
| Name |
Required |
Type |
Default |
| var |
Required |
any |
|
| isAbort |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Facade for cfmx dump |
| Description: |
|
|
|
| $HTMLHEAD |
| function $htmlhead |
Arguments:
| Name |
Required |
Type |
Default |
| content |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade to cfhtmlhead |
| Description: |
|
|
|
| $INCLUDE |
| function $include |
Arguments:
| Name |
Required |
Type |
Default |
| template |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Facade for cfinclude |
| Description: |
|
|
|
| $RETHROW |
| function $rethrow |
Arguments:
| Name |
Required |
Type |
Default |
| throwObject |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Rethrow facade |
| Description: |
|
|
|
| $THROW |
| function $throw |
Arguments:
| Name |
Required |
Type |
Default |
| message |
Required |
string |
|
| detail |
Optional |
string |
[empty string] |
| type |
Optional |
string |
Framework |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade for cfthrow |
| Description: |
|
|
|
| ADDASSET |
| function addAsset |
Arguments:
| Name |
Required |
Type |
Default |
| asset |
Required |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Add a js/css asset(s) to the html head section. You can also pass in a list of assets. |
| Description: |
|
|
|
| ANNOUNCEINTERCEPTION |
| function announceInterception |
Arguments:
| Name |
Required |
Type |
Default |
| state |
Required |
any |
|
| interceptData |
Optional |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Announce an interception to the system. |
| Description: |
|
|
|
| CLEARALL |
| function clearAll |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Clear the entire coldbox session storage |
| Description: |
|
|
|
| CREATESTORAGE |
| function createStorage |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Create the session storage scope |
| Description: |
|
|
|
| DELETEVAR |
| function deleteVar |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Tries to delete a permanent session var. |
| Description: |
|
|
|
| EXISTS |
| function exists |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Checks wether the permanent variable exists. |
| Description: |
|
|
|
| GETCOLDBOXOCM |
| function getColdboxOCM |
Arguments:
| Name |
Required |
Type |
Default |
| cacheName |
Optional |
any |
default |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get a CacheBox Cache of type: coldbox.system.cache.IColdboxApplicationCache |
| Description: |
|
|
|
| GETCONTROLLER |
| function getController |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get controller: coldbox.system.web.Controller |
| Description: |
|
|
|
| GETDATASOURCE |
| function getDatasource |
Arguments:
| Name |
Required |
Type |
Default |
| alias |
Optional |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I will return to you a datasourceBean according to the alias of the datasource you wish to get from the configstruct |
| Description: |
|
|
|
| GETDEBUGMODE |
| function getDebugMode |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade to get your current debug mode |
| Description: |
|
|
|
| GETFWLOCALE |
| function getfwLocale |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the user's currently set locale or default locale |
| Description: |
|
|
|
| GETINTERCEPTOR |
| function getInterceptor |
Arguments:
| Name |
Required |
Type |
Default |
| interceptorName |
Optional |
any |
|
| deepSearch |
Optional |
any |
false |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get an interceptor |
| Description: |
|
|
|
| GETMAILSERVICE |
| function getMailService |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get a reference to our Mail Service plugin |
| Description: |
|
|
|
| GETMAILSETTINGS |
| function getMailSettings |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I will return to you a mailsettingsBean modeled after your mail settings in your config file. |
| Description: |
|
|
|
| GETMEMENTO |
| function getMemento |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the memento of this object |
| Description: |
|
|
|
| GETMODEL |
| function getModel |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Optional |
Any |
|
| dsl |
Optional |
Any |
|
| initArguments |
Optional |
Any |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Create or retrieve model objects by convention |
| Description: |
|
|
|
| GETMODULESETTINGS |
| function getModuleSettings |
Arguments:
| Name |
Required |
Type |
Default |
| module |
Required |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get a module's setting structure if it exists |
| Description: |
|
|
|
| GETMYPLUGIN |
| function getMyPlugin |
Arguments:
| Name |
Required |
Type |
Default |
| plugin |
Required |
any |
|
| newInstance |
Optional |
any |
false |
| module |
Optional |
any |
[empty string] |
| init |
Optional |
any |
true |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| GETNEWMAIL |
| function getNewMail |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get a new mail payload object ready for sending email through our mail service. This function's arguments match the cfmail tag, so send whatever you like |
| Description: |
|
|
|
| GETPLUGIN |
| function getPlugin |
Arguments:
| Name |
Required |
Type |
Default |
| plugin |
Optional |
any |
|
| customPlugin |
Optional |
any |
false |
| newInstance |
Optional |
any |
false |
| module |
Optional |
any |
[empty string] |
| init |
Optional |
any |
true |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| GETPLUGINAUTHOR |
| function getpluginAuthor |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the instance's pluginAuthor |
| Description: |
|
|
|
| GETPLUGINAUTHORURL |
| function getpluginAuthorURL |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the instance's pluginAuthorURL |
| Description: |
|
|
|
| GETPLUGINDESCRIPTION |
| function getPluginDescription |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the instance's pluginDescription |
| Description: |
|
|
|
| GETPLUGINNAME |
| function getPluginName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the instance's pluginName |
| Description: |
|
|
|
| GETPLUGINPATH |
| function getpluginPath |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the instance's pluginPath |
| Description: |
|
|
|
| GETPLUGINVERSION |
| function getPluginVersion |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the instance's pluginVersion |
| Description: |
|
|
|
| GETPROPERTYMIXIN |
| function getPropertyMixin |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| scope |
Optional |
Any |
variables |
| default |
Optional |
Any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
gets a property |
| Description: |
|
|
|
| GETRESOURCE |
| function getResource |
Arguments:
| Name |
Required |
Type |
Default |
| resource |
Required |
any |
|
| default |
Optional |
any |
|
| locale |
Optional |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade to i18n.getResource. Returns a string. |
| Description: |
|
|
|
| GETSETTING |
| function getSetting |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
any |
|
| FWSetting |
Optional |
boolean |
false |
| defaultValue |
Optional |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| GETSETTINGSBEAN |
| function getSettingsBean |
Arguments:
| Name |
Required |
Type |
Default |
| FWSetting |
Optional |
boolean |
false |
|
| ReturnType: |
coldbox.system.core.collections.ConfigBean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns a configBean with all the configuration structure. |
| Description: |
|
|
|
| GETSETTINGSTRUCTURE |
| function getSettingStructure |
Arguments:
| Name |
Required |
Type |
Default |
| FWSetting |
Optional |
boolean |
false |
| DeepCopyFlag |
Optional |
boolean |
false |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| GETSTORAGE |
| function getStorage |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get the entire storage scope |
| Description: |
|
|
|
| GETVAR |
| function getVar |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| default |
Optional |
any |
[empty string] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get a new permanent variable. If the variable does not exist. The method returns blank. |
| Description: |
|
|
|
| INCLUDEITMIXIN |
| function includeitMixin |
Arguments:
| Name |
Required |
Type |
Default |
| template |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Facade for cfinclude |
| Description: |
|
|
|
| INCLUDEUDF |
| function includeUDF |
Arguments:
| Name |
Required |
Type |
Default |
| udflibrary |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Injects a UDF Library (*.cfc or *.cfm) into the target object. It does not however, put the mixins on any of the cfc scopes. Therefore they can only be called internally. |
| Description: |
|
|
|
| INIT |
| function init |
Arguments:
| Name |
Required |
Type |
Default |
| controller |
Required |
any |
|
|
| ReturnType: |
SessionStorage
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INJECTMIXIN |
| function injectMixin |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
Any |
|
| UDF |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Injects a method into the CFC |
| Description: |
|
|
|
| INJECTPROPERTYMIXIN |
| function injectPropertyMixin |
Arguments:
| Name |
Required |
Type |
Default |
| propertyName |
Required |
Any |
|
| propertyValue |
Required |
Any |
|
| scope |
Optional |
Any |
variables |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
injects a property into the passed scope |
| Description: |
|
|
|
| INVOKERMIXIN |
| function invokerMixin |
Arguments:
| Name |
Required |
Type |
Default |
| method |
Required |
Any |
|
| argCollection |
Optional |
Any |
|
| argList |
Optional |
Any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Calls private/packaged/public methods |
| Description: |
|
|
|
| LOADGLOBALUDFLIBRARIES |
| function loadGlobalUDFLibraries |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Load the global UDF libraries defined in the UDFLibraryFile Setting |
| Description: |
|
|
|
| LOCATEDIRECTORYPATH |
| function locateDirectoryPath |
Arguments:
| Name |
Required |
Type |
Default |
| pathToCheck |
Required |
any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Locate the real path location of a directory in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path |
| Description: |
|
|
|
| LOCATEFILEPATH |
| function locateFilePath |
Arguments:
| Name |
Required |
Type |
Default |
| pathToCheck |
Required |
any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Locate the real path location of a file in a coldbox application. 3 checks: 1) inside of coldbox app, 2) expand the path, 3) Absolute location. If path not found, it returns an empty path |
| Description: |
|
|
|
| PERSISTVARIABLES |
| function persistVariables |
Arguments:
| Name |
Required |
Type |
Default |
| persist |
Optional |
string |
[empty string] |
| persistStruct |
Optional |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Persist variables for flash redirections |
| Description: |
|
|
|
| POPULATEMODEL |
| function populateModel |
Arguments:
| Name |
Required |
Type |
Default |
| model |
Required |
any |
|
| scope |
Optional |
any |
[empty string] |
| trustedSetter |
Optional |
any |
false |
| include |
Optional |
any |
[empty string] |
| exclude |
Optional |
any |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Populate a named or instantiated model (java/cfc) from the request collection items |
| Description: |
|
|
|
| POPULATEPROPERTYMIXIN |
| function populatePropertyMixin |
Arguments:
| Name |
Required |
Type |
Default |
| propertyName |
Required |
Any |
|
| propertyValue |
Required |
Any |
|
| scope |
Optional |
Any |
variables |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Populates a property if it exists |
| Description: |
|
|
|
| RELOCATE |
| function relocate |
Arguments:
| Name |
Required |
Type |
Default |
| url |
Required |
string |
|
| addtoken |
Optional |
boolean |
false |
| postProcessExempt |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
This method will be deprecated, please use setNextEvent() instead. |
| Description: |
|
|
|
| REMOVEMIXIN |
| function removeMixin |
Arguments:
| Name |
Required |
Type |
Default |
| UDFName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Removes a method in a CFC |
| Description: |
|
|
|
| REMOVEPROPERTYMIXIN |
| function removePropertyMixin |
Arguments:
| Name |
Required |
Type |
Default |
| propertyName |
Required |
Any |
|
| scope |
Optional |
Any |
variables |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
removes a property from the cfc used. |
| Description: |
|
|
|
| REMOVESTORAGE |
| function removeStorage |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
remove the entire storage scope |
| Description: |
|
|
|
| RENDEREXTERNALVIEW |
| function renderExternalView |
Arguments:
| Name |
Required |
Type |
Default |
| view |
Required |
any |
|
| cache |
Optional |
any |
|
| cacheTimeout |
Optional |
any |
|
| cacheLastAccessTimeout |
Optional |
any |
|
| cacheSuffix |
Optional |
any |
|
| args |
Optional |
any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders external views |
| Description: |
|
|
|
| RENDERLAYOUT |
| function renderLayout |
Arguments:
| Name |
Required |
Type |
Default |
| layout |
Optional |
any |
|
| view |
Optional |
any |
|
| module |
Optional |
any |
|
| args |
Optional |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
Public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders a layout with view combinations |
| Description: |
|
|
|
| RENDERVIEW |
| function renderView |
Arguments:
| Name |
Required |
Type |
Default |
| view |
Required |
any |
|
| cache |
Optional |
any |
|
| cacheTimeout |
Optional |
any |
|
| cacheLastAccessTimeout |
Optional |
any |
|
| cacheSuffix |
Optional |
any |
|
| module |
Optional |
any |
|
| args |
Optional |
any |
|
| collection |
Optional |
any |
|
| collectionAs |
Optional |
any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Renders all kinds of views |
| Description: |
|
|
|
| RUNEVENT |
| function runEvent |
Arguments:
| Name |
Required |
Type |
Default |
| event |
Optional |
any |
[empty string] |
| prepostExempt |
Optional |
any |
false |
| private |
Optional |
any |
false |
| default |
Optional |
any |
false |
| eventArguments |
Optional |
any |
[runtime expression] |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade to controller's runEvent() method. |
| Description: |
|
|
|
| SETDEBUGMODE |
| function setDebugMode |
Arguments:
| Name |
Required |
Type |
Default |
| mode |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade to set your debug mode |
| Description: |
|
|
|
| SETFWLOCALE |
| function setfwLocale |
Arguments:
| Name |
Required |
Type |
Default |
| locale |
Optional |
any |
|
| dontloadRBFlag |
Optional |
any |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set the default locale to use in the framework for a specific user. Utility Method |
| Description: |
|
|
|
| SETNEXTEVENT |
| function setNextEvent |
Arguments:
| Name |
Required |
Type |
Default |
| event |
Optional |
string |
|
| queryString |
Optional |
string |
|
| addToken |
Optional |
boolean |
|
| persist |
Optional |
string |
|
| persistStruct |
Optional |
struct |
|
| ssl |
Optional |
boolean |
|
| baseURL |
Optional |
string |
|
| postProcessExempt |
Optional |
boolean |
|
| URL |
Optional |
string |
|
| URI |
Optional |
string |
|
| statusCode |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| SETNEXTROUTE |
| function setNextRoute |
Arguments:
| Name |
Required |
Type |
Default |
| route |
Required |
string |
|
| persist |
Optional |
string |
[empty string] |
| persistStruct |
Optional |
struct |
|
| addToken |
Optional |
boolean |
false |
| ssl |
Optional |
boolean |
false |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
This method is now deprecated, please use setNextEvent(). This method will be removed later on |
| Description: |
|
|
|
| SETPLUGINAUTHOR |
| function setpluginAuthor |
Arguments:
| Name |
Required |
Type |
Default |
| pluginAuthor |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set the instance's pluginAuthor |
| Description: |
|
|
|
| SETPLUGINAUTHORURL |
| function setpluginAuthorURL |
Arguments:
| Name |
Required |
Type |
Default |
| pluginAuthorURL |
Required |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set the instance's pluginAuthorURL |
| Description: |
|
|
|
| SETPLUGINDESCRIPTION |
| function setPluginDescription |
Arguments:
| Name |
Required |
Type |
Default |
| pluginDescription |
Required |
Any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set the instance's pluginDescription |
| Description: |
|
|
|
| SETPLUGINNAME |
| function setPluginName |
Arguments:
| Name |
Required |
Type |
Default |
| pluginName |
Required |
Any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set the instance's pluginName |
| Description: |
|
|
|
| SETPLUGINVERSION |
| function setPluginVersion |
Arguments:
| Name |
Required |
Type |
Default |
| pluginVersion |
Required |
Any |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set the instance's pluginVersion |
| Description: |
|
|
|
| SETSETTING |
| function setSetting |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
any |
|
| value |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| SETTINGEXISTS |
| function settingExists |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
any |
|
| FWSetting |
Optional |
boolean |
false |
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Facade |
| Description: |
|
|
|
| SETVAR |
| function setVar |
Arguments:
| Name |
Required |
Type |
Default |
| name |
Required |
string |
|
| value |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set a new permanent variable. |
| Description: |
|
|
|