From 974adb78e22f828b5fa5cc77c0518f21d04d124b Mon Sep 17 00:00:00 2001
From: the-djmaze <>
Date: Thu, 19 Jan 2023 20:09:52 +0100
Subject: [PATCH] Start documenting JavaScript `rl` object as noted in #865

---
 plugins/README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)

diff --git a/plugins/README.md b/plugins/README.md
index f070e6aa0..28ce1583a 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -439,3 +439,74 @@ and called in JavaScript using rl.pluginRemoteRequest().
 ### sm-show-screen
 	event.detail = 'screenname'
 	cancelable using preventDefault()
+
+
+# JavaScript `rl` object
+
+## rl.Enums.StorageResultType
+### rl.Enums.StorageResultType.Abort
+### rl.Enums.StorageResultType.Error
+### rl.Enums.StorageResultType.Success
+
+## rl.​Utils.htmlToPlain(html)
+Converts HTML to text
+
+## rl.Utils.plainToHtml(plain)
+Converts text to HTML
+
+## rl.addSettingsViewModel(SettingsViewModelClass, template, labelName, route)​
+
+## rl.addSettingsViewModelForAdmin(SettingsViewModelClass, template, labelName, route)​
+
+## rl.adminArea()​
+Returns true or false
+
+## rl.app.Remote.abort(action)​​​​​
+
+## rl.app.Remote.get(action, url)​​​​​
+
+## rl.app.Remote.getPublicKey(fCallback)​​​​​
+
+## rl.app.Remote.post(action, fTrigger, params, timeOut)​​​​​
+
+## rl.app.Remote.request(action, fCallback, params, iTimeout, sGetAdd)​​​​​
+
+## rl.app.Remote.setTrigger(trigger, value)​​​​​
+
+## rl.app.Remote.streamPerLine(fCallback, sGetAdd, postData)
+
+## rl.app.folderList
+A knockout observable array of all folders/mailboxes
+
+## rl.fetch(resource, init, postData)​
+
+## rl.fetchJSON(resource, init, postData)​
+
+## rl.i18n(key, valueList, defaulValue)​
+
+## rl.loadScript(src)​
+
+## rl.logoutReload(url)​
+
+## rl.pluginPopupView
+class AbstractViewPopup
+
+## rl.pluginRemoteRequest(callback, action, parameters, timeout)​
+
+## rl.pluginSettingsGet(pluginSection, name)​
+
+## rl.registerWYSIWYG(name, construct)​
+
+## rl.route.root()
+
+## rl.route.reload()
+
+## rl.route.off()
+
+## rl.setTitle(title)​
+
+## rl.settings.get(name)
+
+## rl.settings.set(name, value)
+
+## rl.settings.app(name)