pandemonium_engine/modules/users/doc_classes/UserWebPage.xml

69 lines
2.8 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="UserWebPage" inherits="WebNode" version="4.3">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_handle_logged_in" qualifiers="virtual">
<return type="void" />
<argument index="0" name="request" type="WebServerRequest" />
<description>
</description>
</method>
<method name="_handle_not_logged_in" qualifiers="virtual">
<return type="void" />
<argument index="0" name="request" type="WebServerRequest" />
<description>
</description>
</method>
<method name="_render_user_page" qualifiers="virtual">
<return type="void" />
<argument index="0" name="request" type="WebServerRequest" />
<argument index="1" name="data" type="Dictionary" />
<description>
Implementing this method will make the system call it instead of the normal built in html rendering methods on the engine side.
This is when you want to only customize the rendered html. If you need to change backend logic, look at the other available virtuals.
</description>
</method>
<method name="handle_logged_in">
<return type="void" />
<argument index="0" name="request" type="WebServerRequest" />
<description>
</description>
</method>
<method name="handle_not_logged_in">
<return type="void" />
<argument index="0" name="request" type="WebServerRequest" />
<description>
</description>
</method>
</methods>
<members>
<member name="logged_in_error_code" type="int" setter="set_logged_in_error_code" getter="get_logged_in_error_code" default="404">
</member>
<member name="logged_in_redirect_url" type="String" setter="set_logged_in_redirect_url" getter="get_logged_in_redirect_url" default="&quot;&quot;">
</member>
<member name="logged_in_render_type" type="int" setter="set_logged_in_render_type" getter="get_logged_in_render_type" enum="UserWebPage.RenderType" default="0">
</member>
<member name="logged_out_error_code" type="int" setter="set_logged_out_error_code" getter="get_logged_out_error_code" default="404">
</member>
<member name="logged_out_redirect_url" type="String" setter="set_logged_out_redirect_url" getter="get_logged_out_redirect_url" default="&quot;&quot;">
</member>
<member name="logged_out_render_type" type="int" setter="set_logged_out_render_type" getter="get_logged_out_render_type" enum="UserWebPage.RenderType" default="2">
</member>
<member name="render_menu" type="bool" setter="set_render_menu" getter="get_render_menu" default="true">
</member>
</members>
<constants>
<constant name="RENDER_TYPE_RENDER" value="0" enum="RenderType">
</constant>
<constant name="RENDER_TYPE_REDIRECT" value="1" enum="RenderType">
</constant>
<constant name="RENDER_TYPE_ERROR" value="2" enum="RenderType">
</constant>
</constants>
</class>