Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-01-23 17:47:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added docs for RedirectWebPage, and AliasWebPage.

Browse Source
This commit is contained in:
Relintai 2022-08-21 23:09:57 +02:00
parent 5b16231128
commit ba0248ae5e
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
modules/web/doc_classes/AliasWebPage.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="AliasWebPage" inherits="WebNode" version="3.7"> <class name="AliasWebPage" inherits="WebNode" version="3.7">
<brief_description> <brief_description>
Creates an alias web uri.
</brief_description> </brief_description>
<description> <description>
Essentially when it handles a request it calls an another [WebNode]'s [code]handle_request()[/code] method.
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -10,6 +12,7 @@
</methods> </methods>
<members> <members>
<member name="alias_path" type="NodePath" setter="set_alias_path" getter="get_alias_path" default="NodePath(&quot;&quot;)"> <member name="alias_path" type="NodePath" setter="set_alias_path" getter="get_alias_path" default="NodePath(&quot;&quot;)">
The path to the target [Webnode].
</member> </member>
</members> </members>
<constants> <constants>

4
modules/web/doc_classes/RedirectWebPage.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="RedirectWebPage" inherits="WebNode" version="3.7"> <class name="RedirectWebPage" inherits="WebNode" version="3.7">
<brief_description> <brief_description>
Sends a redirect when it needs to handle a request.
</brief_description> </brief_description>
<description> <description>
It handles a request by sending a redirect to the [code]redirect_path[/code].
</description> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -10,8 +12,10 @@
</methods> </methods>
<members> <members>
<member name="code" type="int" setter="set_code" getter="get_code" default="302"> <member name="code" type="int" setter="set_code" getter="get_code" default="302">
The response code.
</member> </member>
<member name="redirect_path" type="String" setter="set_redirect_path" getter="get_redirect_path" default="&quot;&quot;"> <member name="redirect_path" type="String" setter="set_redirect_path" getter="get_redirect_path" default="&quot;&quot;">
The http path to redirect to.
</member> </member>
</members> </members>
<constants> <constants>