From f8e1df2476074a86e4dc25204c2250a6111245de Mon Sep 17 00:00:00 2001 From: Mattes D Date: Wed, 6 Jul 2016 12:39:56 +0200 Subject: Updated API documentation. --- Server/Plugins/APIDump/Classes/WebAdmin.lua | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'Server/Plugins/APIDump/Classes/WebAdmin.lua') diff --git a/Server/Plugins/APIDump/Classes/WebAdmin.lua b/Server/Plugins/APIDump/Classes/WebAdmin.lua index a9d92b069..46f993f4a 100644 --- a/Server/Plugins/APIDump/Classes/WebAdmin.lua +++ b/Server/Plugins/APIDump/Classes/WebAdmin.lua @@ -52,6 +52,17 @@ return Username = { Type = "string", Notes = "Name of the logged-in user." }, }, }, -- HTTPRequest + + + HTTPTemplateRequest = + { + Desc = [[This class is used only in the WebAdmin template script as the parameter to the function that provides the template. + ]], + Variables = + { + Request = { Type = "HTTPRequest", Notes = "The request for which the template is being built." }, + }, + }, -- HTTPTemplateRequest } -- cgit v1.2.3 From 0e24a0beaef55a4753ce4db9d3f5f9a3872bd026 Mon Sep 17 00:00:00 2001 From: Mattes D Date: Wed, 6 Jul 2016 16:11:15 +0200 Subject: APIDump: Added explicit IsStatic flag to static functions. --- Server/Plugins/APIDump/Classes/WebAdmin.lua | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'Server/Plugins/APIDump/Classes/WebAdmin.lua') diff --git a/Server/Plugins/APIDump/Classes/WebAdmin.lua b/Server/Plugins/APIDump/Classes/WebAdmin.lua index 46f993f4a..ec37d9308 100644 --- a/Server/Plugins/APIDump/Classes/WebAdmin.lua +++ b/Server/Plugins/APIDump/Classes/WebAdmin.lua @@ -5,14 +5,14 @@ return Desc = "", Functions = { - AddWebTab = { Params = "Title, UrlPath, HandlerFn", Return = "", Notes = "(STATIC) Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:
function ({{a_Request|HTTPRequest}}, a_UrlPath)
  return Content, ContentType
end
URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set." }, - GetAllWebTabs = { Params = "", Return = "array-table", Notes = "(STATIC) Returns an array-table with each item describing a web tab, for all web tabs registered in the WebAdmin, for all plugins. The returned table has the following format:
{
  {
    PluginName = \"Plugin's API name\",
    UrlPath = \"UrlPath given to AddWebTab\",
    Title = \"Title given to AddWebTab\",
  },
  ...
}"},
-			GetBaseURL = { Params = "URL", Return = "string", Notes = "(STATIC) Returns the string that is the path of the base webadmin (\"../../../webadmin\") relative to the given URL." },
-			GetContentTypeFromFileExt = { Params = "FileExt", Return = "string", Notes = "(STATIC) Returns the content-type that should be used for files with the specified extension (without the dot), such as \"text/plain\" for the \"txt\" extension. If the extension is not known, returns an empty string." },
-			GetHTMLEscapedString = { Params = "string", Return = "string", Notes = "(STATIC) Gets the HTML-escaped representation of a requested string. This is useful for user input and game data that is not guaranteed to be escaped already." },
-			GetPage = { Params = "{{Request|HTTPRequest}}", Return = "table", Notes = "(STATIC) Returns the (inner HTML) page contents for the specified request. Calls the appropriate WebTab handler registered via AddWebTab() and returns the information from that plugin wrapped in a table with the following structure:
{
  Content = \"\",      -- Content returned by the plugin
  ContentType = \"\",  -- Content type returned by the plugin, or \"text/html\" if none returned
  UrlPath = \"\",      -- UrlPath decoded from the request
  TabTitle = \"\",     -- Title of the tab that handled the request, as given to AddWebTab()
  PluginName = \"\",   -- API name of the plugin that handled the request
  PluginFolder = \"\", -- Folder name (= display name) of the plugin that handled the request
}
This function is mainly used in the webadmin template file." },
+			AddWebTab = { Params = "Title, UrlPath, HandlerFn", Return = "", IsStatic = true, Notes = "Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:
function ({{a_Request|HTTPRequest}}, a_UrlPath)
  return Content, ContentType
end
 URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set." },
+			GetAllWebTabs = { Params = "", Return = "array-table", IsStatic = true, Notes = "Returns an array-table with each item describing a web tab, for all web tabs registered in the WebAdmin, for all plugins. The returned table has the following format:
{
  {
    PluginName = \"Plugin's API name\",
    UrlPath = \"UrlPath given to AddWebTab\",
    Title = \"Title given to AddWebTab\",
  },
  ...
}"},
+			GetBaseURL = { Params = "URL", Return = "string", IsStatic = true, Notes = "Returns the string that is the path of the base webadmin (\"../../../webadmin\") relative to the given URL." },
+			GetContentTypeFromFileExt = { Params = "FileExt", Return = "string", IsStatic = true, Notes = "Returns the content-type that should be used for files with the specified extension (without the dot), such as \"text/plain\" for the \"txt\" extension. If the extension is not known, returns an empty string." },
+			GetHTMLEscapedString = { Params = "string", Return = "string", IsStatic = true, Notes = "Gets the HTML-escaped representation of a requested string. This is useful for user input and game data that is not guaranteed to be escaped already." },
+			GetPage = { Params = "{{Request|HTTPRequest}}", Return = "table", IsStatic = true, Notes = "Returns the (inner HTML) page contents for the specified request. Calls the appropriate WebTab handler registered via AddWebTab() and returns the information from that plugin wrapped in a table with the following structure:
{
  Content = \"\",      -- Content returned by the plugin
  ContentType = \"\",  -- Content type returned by the plugin, or \"text/html\" if none returned
  UrlPath = \"\",      -- UrlPath decoded from the request
  TabTitle = \"\",     -- Title of the tab that handled the request, as given to AddWebTab()
  PluginName = \"\",   -- API name of the plugin that handled the request
  PluginFolder = \"\", -- Folder name (= display name) of the plugin that handled the request
}
This function is mainly used in the webadmin template file." },
 			GetPorts = { Params = "", Return = "string", Notes = "Returns a comma-separated list of ports on which the webadmin is configured to listen. Note that this list does include ports that may currently be unavailable (another server was already listening on them prior to launching Cuberite)." },
-			GetURLEncodedString = { Params = "string", Return = "string", Notes = "(STATIC) Returns the string given to it escaped by URL encoding, which makes the string suitable for transmission in an URL. Invalid characters are turned into \"%xy\" values." },
+			GetURLEncodedString = { Params = "string", Return = "string", IsStatic = true, Notes = "Returns the string given to it escaped by URL encoding, which makes the string suitable for transmission in an URL. Invalid characters are turned into \"%xy\" values." },
 			Reload = { Params = "", Return = "", Notes = "Reloads the webadmin's config - the allowed logins, the template script and the login page. Note that reloading will not change the \"enabled\" state of the server, and it will not update listening ports. Existing WebTabs will be kept registered even after the reload." },
 		},
 	},  -- cWebAdmin
-- 
cgit v1.2.3