ATTENTION

You're browsing the documentation for an development version of froxlor.
The current stable version's documentation can be found here.

Froxlor

Froxlor.checkUpdate

checks whether there is a newer version of froxlor available

Permission

admin

Parameter

FieldTypeDescription
forcebooloptional, force live update-check

Response

string as json-encoded array

Froxlor.importSettings

import settings

Permission

admin

Parameter

FieldTypeDescription
json_strstringcontent of exported froxlor-settings json file

Response

string as json-encoded bool

Froxlor.exportSettings

export settings

Permission

admin

Response

string as json-string

Froxlor.listSettings

return a list of all settings

Permission

admin

Response

string as json-encoded array count|list

Froxlor.getSetting

return a setting by settinggroup.varname couple

Permission

admin

Parameter

FieldTypeDescription
keystringsettinggroup.varname couple

Response

string

Froxlor.updateSetting

updates a setting

Permission

admin

Parameter

FieldTypeDescription
keystringsettinggroup.varname couple
valuestringoptional the new value, default is ''

Response

string

Froxlor.generatePassword

returns a random password based on froxlor settings for min-length, included characters, etc.

Permission

admin customer

Parameter

FieldTypeDescription
lengthintoptional length of password, defaults to 10

Response

string

Froxlor.integrityCheck

can be used to remotely run the integritiy checks froxlor implements

Permission

admin

Response

string

Froxlor.listFunctions

returns a list of all available api functions

Permission

admin customer

Parameter

FieldTypeDescription
modulestringoptional, return list of functions for a specific module
functionstringoptional, return parameter information for a specific module and function

Response

string as json-encoded array