pandemonium_engine/modules/web/doc_classes/WebServerCookie.xml

89 lines
3.1 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebServerCookie" inherits="Reference" version="3.8">
<brief_description>
Used by [WebServerRequest]s, to set or delete cookies on the client.
</brief_description>
<description>
Used by [WebServerRequest]s, to set or delete cookies on the client.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_expiry_date">
<return type="Dictionary" />
<description>
</description>
</method>
<method name="get_expiry_date_unix_time">
<return type="int" />
<description>
</description>
</method>
<method name="get_response_header_string">
<return type="String" />
<description>
</description>
</method>
<method name="set_data">
<return type="void" />
<argument index="0" name="key" type="String" />
<argument index="1" name="value" type="String" />
<description>
</description>
</method>
<method name="set_expiry_date">
<return type="void" />
<argument index="0" name="date" type="Dictionary" />
<argument index="1" name="time" type="Dictionary" />
<description>
</description>
</method>
<method name="set_expiry_date_dt">
<return type="void" />
<argument index="0" name="date_time" type="Dictionary" />
<description>
</description>
</method>
<method name="set_expiry_date_unix_time">
<return type="void" />
<argument index="0" name="unix_time" type="int" />
<description>
</description>
</method>
</methods>
<members>
<member name="delete" type="bool" setter="set_delete" getter="get_delete" default="false">
</member>
<member name="domain" type="String" setter="set_domain" getter="get_domain" default="&quot;&quot;">
</member>
<member name="http_only" type="bool" setter="set_http_only" getter="get_http_only" default="true">
</member>
<member name="key" type="String" setter="set_key" getter="get_key" default="&quot;&quot;">
</member>
<member name="max_age" type="int" setter="set_max_age" getter="get_max_age" default="0">
</member>
<member name="path" type="String" setter="set_path" getter="get_path" default="&quot;&quot;">
</member>
<member name="same_site" type="int" setter="set_same_site" getter="get_same_site" enum="WebServerCookie.SameSiteValues" default="0">
</member>
<member name="secure" type="bool" setter="set_secure" getter="get_secure" default="false">
</member>
<member name="use_expiry_date" type="bool" setter="set_use_expiry_date" getter="get_use_expiry_date" default="false">
</member>
<member name="use_max_age" type="bool" setter="set_use_max_age" getter="get_use_max_age" default="false">
</member>
<member name="value" type="String" setter="set_value" getter="get_value" default="&quot;&quot;">
</member>
</members>
<constants>
<constant name="SAME_SITE_UNSET" value="0" enum="SameSiteValues">
</constant>
<constant name="SAME_SITE_NONE" value="1" enum="SameSiteValues">
</constant>
<constant name="SAME_SITE_LAX" value="2" enum="SameSiteValues">
</constant>
<constant name="SAME_SITE_STRICT" value="3" enum="SameSiteValues">
</constant>
</constants>
</class>