<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>
Bugzilla::WebService::Bugzilla</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" title="style" type="text/css" href="../.././../../../style.css" media="all" >
</head>
<body id="pod">
<p class="backlinktop"><b><a name="___top" href="../../index.html" accesskey="1" title="All Documents"><<</a></b></p>
<h1>Bugzilla::WebService::Bugzilla</h1>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#version'>version</a>
<li class='indexItem indexItem2'><a href='#extensions'>extensions</a>
<li class='indexItem indexItem2'><a href='#timezone'>timezone</a>
<li class='indexItem indexItem2'><a href='#time'>time</a>
<li class='indexItem indexItem2'><a href='#parameters'>parameters</a>
<li class='indexItem indexItem2'><a href='#last_audit_time'>last_audit_time</a>
</ul>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Bugzilla::WebService::Bugzilla - Global functions for the webservice interface.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>
<p>This provides functions that tell you about Bugzilla in general.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>
<p>See <a href="../../Bugzilla/WebService.html" class="podlinkpod"
>Bugzilla::WebService</a> for a description of how parameters are passed,
and what <b>STABLE</b>,
<b>UNSTABLE</b>,
and <b>EXPERIMENTAL</b> mean.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="version"
>version</a></h2>
<p><b>STABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Returns the current version of Bugzilla.</p>
<dt><a name="Params_(none)"
><b>Params</b> (none)</a></dt>
<dd>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with a single item,
<code class="code">version</code>,
that is the version as a string.</p>
<dt><a name="Errors_(none)"
><b>Errors</b> (none)</a></dt>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="extensions"
>extensions</a></h2>
<p><b>EXPERIMENTAL</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Gets information about the extensions that are currently installed and enabled in this Bugzilla.</p>
<dt><a name="Params_(none)"
><b>Params</b> (none)</a></dt>
<dd>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with a single item,
<code class="code">extensions</code>.
This points to a hash.
<i>That</i> hash contains the names of extensions as keys,
and the values are a hash.
That hash contains a single key <code class="code">version</code>,
which is the version of the extension,
or <code class="code">0</code> if the extension hasn't defined a version.</p>
<p>The return value looks something like this:</p>
<pre class="code"> extensions => {
Example => {
version => '3.6',
},
BmpConvert => {
version => '1.0',
},
}</pre>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_3.2."
>Added in Bugzilla <b>3.2</b>.</a></dt>
<dd>
<dt><a
>As of Bugzilla <b>3.6</b>, the names of extensions are canonical names that the extensions define themselves. Before 3.6, the names of the extensions depended on the directory they were in on the Bugzilla server.</a></dt>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="timezone"
>timezone</a></h2>
<p><b>DEPRECATED</b> This method may be removed in a future version of Bugzilla. Use <a href="#time" class="podlinkpod"
>"time"</a> instead.</p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Returns the timezone that Bugzilla expects dates and times in.</p>
<dt><a name="Params_(none)"
><b>Params</b> (none)</a></dt>
<dd>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with a single item, <code class="code">timezone</code>, that is the timezone offset as a string in (+/-)XXXX (RFC 2822) format.</p>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="As_of_Bugzilla_3.6,_the_timezone_returned_is_always_+0000_(the_UTC_timezone)."
>As of Bugzilla <b>3.6</b>, the timezone returned is always <code class="code">+0000</code> (the UTC timezone).</a></dt>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="time"
>time</a></h2>
<p><b>STABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Gets information about what time the Bugzilla server thinks it is, and what timezone it's running in.</p>
<dt><a name="Params_(none)"
><b>Params</b> (none)</a></dt>
<dd>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A struct with the following items:</p>
<dl>
<dt><a name="db_time"
><code class="code">db_time</code></a></dt>
<dd>
<p><code class="code">dateTime</code> The current time in UTC, according to the Bugzilla <i>database server</i>.</p>
<p>Note that Bugzilla assumes that the database and the webserver are running in the same time zone. However, if the web server and the database server aren't synchronized for some reason, <i>this</i> is the time that you should rely on for doing searches and other input to the WebService.</p>
<dt><a name="web_time"
><code class="code">web_time</code></a></dt>
<dd>
<p><code class="code">dateTime</code> This is the current time in UTC, according to Bugzilla's <i>web server</i>.</p>
<p>This might be different by a second from <code class="code">db_time</code> since this comes from a different source. If it's any more different than a second, then there is likely some problem with this Bugzilla instance. In this case you should rely on the <code class="code">db_time</code>, not the <code class="code">web_time</code>.</p>
<dt><a name="web_time_utc"
><code class="code">web_time_utc</code></a></dt>
<dd>
<p>Identical to <code class="code">web_time</code>. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.)</p>
<dt><a name="tz_name"
><code class="code">tz_name</code></a></dt>
<dd>
<p><code class="code">string</code> The literal string <code class="code">UTC</code>. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.)</p>
<dt><a name="tz_short_name"
><code class="code">tz_short_name</code></a></dt>
<dd>
<p><code class="code">string</code> The literal string <code class="code">UTC</code>. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.)</p>
<dt><a name="tz_offset"
><code class="code">tz_offset</code></a></dt>
<dd>
<p><code class="code">string</code> The literal string <code class="code">+0000</code>. (Exists only for backwards-compatibility with versions of Bugzilla before 3.6.)</p>
</dd>
</dl>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_3.4."
>Added in Bugzilla <b>3.4</b>.</a></dt>
<dd>
<dt><a
>As of Bugzilla <b>3.6</b>, this method returns all data as though the server were in the UTC timezone, instead of returning information in the server's local timezone.</a></dt>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="parameters"
>parameters</a></h2>
<p><b>UNSTABLE</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Returns parameter values currently used in this Bugzilla.</p>
<dt><a name="Params_(none)"
><b>Params</b> (none)</a></dt>
<dd>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with a single item <code class="code">parameters</code> which contains a hash with the name of the parameters as keys and their value as values. All values are returned as strings. The list of parameters returned by this method depends on the user credentials:</p>
<p>A logged-out user can only access the <code class="code">maintainer</code> and <code class="code">requirelogin</code> parameters.</p>
<p>A logged-in user can access the following parameters (listed alphabetically): <code class="code">allowemailchange</code>, <code class="code">attachment_base</code>, <code class="code">commentonchange_resolution</code>, <code class="code">commentonduplicate</code>, <code class="code">cookiepath</code>, <code class="code">defaultopsys</code>, <code class="code">defaultplatform</code>, <code class="code">defaultpriority</code>, <code class="code">defaultseverity</code>, <code class="code">duplicate_or_move_bug_status</code>, <code class="code">emailregexpdesc</code>, <code class="code">emailsuffix</code>, <code class="code">letsubmitterchoosemilestone</code>, <code class="code">letsubmitterchoosepriority</code>, <code class="code">mailfrom</code>, <code class="code">maintainer</code>, <code class="code">maxattachmentsize</code>, <code class="code">maxlocalattachment</code>, <code class="code">musthavemilestoneonaccept</code>, <code class="code">noresolveonopenblockers</code>, <code class="code">password_complexity</code>, <code class="code">rememberlogin</code>, <code class="code">requirelogin</code>, <code class="code">search_allow_no_criteria</code>, <code class="code">urlbase</code>, <code class="code">use_see_also</code>, <code class="code">useclassification</code>, <code class="code">usemenuforusers</code>, <code class="code">useqacontact</code>, <code class="code">usestatuswhiteboard</code>, <code class="code">usetargetmilestone</code>.</p>
<p>A user in the tweakparams group can access all existing parameters. New parameters can appear or obsolete parameters can disappear depending on the version of Bugzilla and on extensions being installed. The list of parameters returned by this method is not stable and will never be stable.</p>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_4.4."
>Added in Bugzilla <b>4.4</b>.</a></dt>
</dl>
</dd>
</dl>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="last_audit_time"
>last_audit_time</a></h2>
<p><b>EXPERIMENTAL</b></p>
<dl>
<dt><a name="Description"
><b>Description</b></a></dt>
<dd>
<p>Gets the latest time of the audit_log table.</p>
<dt><a name="Params"
><b>Params</b></a></dt>
<dd>
<p>You can pass the optional parameter <code class="code">class</code> to get the maximum for only the listed classes.</p>
<dl>
<dt><a name="class_(array)_-_An_array_of_strings_representing_the_class_names."
><code class="code">class</code> (array) - An array of strings representing the class names.</a></dt>
<dd>
<p><b>Note:</b> The class names are defined as "Bugzilla::<class_name>". For the product use Bugzilla:Product.</p>
</dd>
</dl>
<dt><a name="Returns"
><b>Returns</b></a></dt>
<dd>
<p>A hash with a single item, <code class="code">last_audit_time</code>, that is the maximum of the at_time from the audit_log.</p>
<dt><a name="Errors_(none)"
><b>Errors</b> (none)</a></dt>
<dd>
<dt><a name="History"
><b>History</b></a></dt>
<dd>
<dl>
<dt><a name="Added_in_Bugzilla_4.4."
>Added in Bugzilla <b>4.4</b>.</a></dt>
</dl>
</dd>
</dl>
<p class="backlinkbottom"><b><a name="___bottom" href="../../index.html" title="All Documents"><<</a></b></p>
<!-- end doc -->
</body></html>
