FuzzyBot: Updating to match new version of source page

2022-02-09T23:04:06Z

Updating to match new version of source page

New page

<languages/>
Allows you to access data and contacts in user profile database.

{{Ls|MirLua/Modules/include_info}} <code>local db = require('m_database')</code>

__TOC__

== Contacts ==

=== Contacts ===
Iterator for list of contacts.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | name
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Protocol name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns contact number. The list ends in element with <code>nil</code> value.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
for hContact in db.Contacts('JABBER_1') do
print(db.GetSetting(hContact, 'JABBER_1', 'Nick'))
end
}}

== Events ==

=== GetEventCount ===
Number of events for a contact.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns number of events.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=db.GetEventCount(hContact)}}
----

=== Events ===
Iterator for contact's event list from the first to the last.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns event number. The list ends in element with <code>nil</code> value.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=for hEvent in db.Events(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}
----

=== EventsFromEnd ===
Iterator for contact's event list from the last to the first.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns event number. The list ends in element with <code>nil</code> value.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
for hEvent in db.EventsFromEnd(hContact) do
local event = totable(hEvent, "DBEVENTINFO")
print(event.Timestamp, event.Blob)
end
}}

== Settings ==

=== GetSetting ===
Returns value of a setting.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number or <code>nil</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | module
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Module name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | setting
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Setting name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | value
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>, <code>string</code>
| Default value.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns value of a setting or default value or <code>nil</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=db.GetSetting(nil, 'test', 'some')}}
----

=== Settings ===
Iterator for module (group of settings).

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number or <code>nil</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | module
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Module name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>number</code>

{{nbsp|5}}Returns module name. The list ends in element with <code>nil</code> value.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=
for setting in db.Settings(nil, 'CList') do
local message = string.format("%s/%s = ", 'CList', setting, ...)
.. db.GetSetting(nil, 'CList', setting)
print(message)
end
}}
----

=== WriteSetting ===
Saves a value to database.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number or <code>nil</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | module
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Module name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | setting
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Setting name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | value
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>boolean</code>, <code>number</code>, <code>string</code>, <code>table</code> (array of bytes)
| Setting value.
|-
! scope="row" class="MirLuaParametersTable-parameter" | type
| style="text-align:center" | {{Ls|YesNo/no}}
| style="text-align:center" | <code>number</code>
| Type of setting. Takes values:
* 1 = DBVT_BYTE
* 2 = DBVT_WORD
* 4 = DBVT_DWORD
* 252 = DBVT_WCHAR
* 253 = DBVT_UTF8
* 254 = DBVT_BLOB
* 255 = DBVT_ASCIIZ
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> on success, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=db.WriteSetting(nil, 'test', 'some', true)}}
----

=== DeleteSetting ===
Deletes a setting.

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number or <code>nil</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | module
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Module name.
|-
! scope="row" class="MirLuaParametersTable-parameter" | setting
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Setting name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> on success, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=db.DeleteSetting(nil, 'test', 'some')}}
----

=== DeleteModule ===
Deletes a module (group of settings).

==== {{Ls|MirLua/Modules/parameters}} ====
{| class="wikitable"
|-
! scope="col" | {{Ls|MirLua/Modules/param_name}}
! scope="col" | {{Ls|MirLua/Modules/required_param}}
! scope="col" | {{Ls|Content/TableHeaders/type}}
! scope="col" | {{Ls|Content/TableHeaders/description}}
|-
! scope="row" class="MirLuaParametersTable-parameter" | hContact
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>number</code>
| Contact number or <code>nil</code>.
|-
! scope="row" class="MirLuaParametersTable-parameter" | module
| style="text-align:center" | {{Ls|YesNo/yes}}
| style="text-align:center" | <code>string</code>
| Module name.
|}

==== {{Ls|MirLua/Modules/result}} ====
{{nbsp|5}}{{Ls|MirLua/Modules/type}} <code>boolean</code>

{{nbsp|5}}Returns <code>true</code> on success, otherwise <code>false</code>.

==== {{Ls|MirLua/Modules/example}} ====
{{Content:MirLua/Example|code=db.DeleteModule(nil, 'test')}}

Plugin:MirLua/Module/m database/en - Revision history

FuzzyBot: Updating to match new version of source page