Debian Codegraph @

docs/rst/scripting/lua_api/lua_session_item_api.rst

raw
1 .. _lua_session_item_api:
2
3 Session Item
4 ============
5
6 Lua objects that bind a :ref:`WpSessionItem <session_item_api>`
7 contain the following methods:
8
9 .. function:: SessionItem.get_associated_proxy(self, type)
10
11 Binds :c:func:`wp_session_item_get_associated_proxy`
12
13 :param self: the session item
14 :param string type: the proxy type name
15 :returns: the proxy object or nil
16
17 .. function:: SessionItem.reset(self)
18
19 Binds :c:func:`wp_session_item_reset`
20
21 :param self: the session item
22
23 .. function:: SessionItem.configure(self, properties)
24
25 Binds :c:func:`wp_session_item_configure`
26
27 :param self: the session item
28 :param table properties: The configuration properties
29 :returns: true on success, false on failure
30 :rtype: boolean
31
32 .. function:: SessionItem.register(self)
33
34 Binds :c:func:`wp_session_item_register`
35
36 :param self: the session item
37
38 .. function:: SessionItem.remove(self)
39
40 Binds :c:func:`wp_session_item_remove`
41
42 :param self: the session item