<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Bugzilla 4.2.1 API Documentation</title>
<link rel="stylesheet" title="style" type="text/css" href="./../../../style.css" media="all" >
</head>
<body class="contentspage">
<h1>Bugzilla 4.2.1 API Documentation</h1>
<dl class='superindex'>
<dt><a name="Extensions">Extensions</a></dt>
<dd>
<table class="pod_desc_table">
<tr class="even">
<th><a href="./extensions/create.html">extensions::create</a></th>
<td>Create a framework for a new Bugzilla Extension.</td>
</tr>
</table></dd>
<dt><a name="Files">Files</a></dt>
<dd>
<table class="pod_desc_table">
<tr class="even">
<th><a href="./checksetup.html">checksetup</a></th>
<td>A do-it-all upgrade and installation script for Bugzilla.</td>
</tr>
<tr class="odd">
<th><a href="./collectstats.html">collectstats</a></th>
<td>Collect data about Bugzilla bugs.</td>
</tr>
<tr class="even">
<th><a href="./contrib/bz_webservice_demo.html">contrib::bz_webservice_demo</a></th>
<td>Show how to talk to Bugzilla via XMLRPC</td>
</tr>
<tr class="odd">
<th><a href="./contrib/bzdbcopy.html">contrib::bzdbcopy</a></th>
<td>Copies data from one Bugzilla database to another.</td>
</tr>
<tr class="even">
<th><a href="./contrib/console.html">contrib::console</a></th>
<td>command-line interface to Bugzilla API</td>
</tr>
<tr class="odd">
<th><a href="./contrib/extension-convert.html">contrib::extension-convert</a></th>
<td>Convert extensions from the pre-3.6 format to the 3.6 format.</td>
</tr>
<tr class="even">
<th><a href="./contrib/merge-users.html">contrib::merge-users</a></th>
<td>Merge two user accounts.</td>
</tr>
<tr class="odd">
<th><a href="./contrib/recode.html">contrib::recode</a></th>
<td>Converts a database from one encoding (or multiple encodings) to UTF-8.</td>
</tr>
<tr class="even">
<th><a href="./email_in.html">email_in</a></th>
<td>The Bugzilla Inbound Email Interface</td>
</tr>
<tr class="odd">
<th><a href="./importxml.html">importxml</a></th>
<td>Import bugzilla bug data from xml.</td>
</tr>
<tr class="even">
<th><a href="./install-module.html">install-module</a></th>
<td>Installs or upgrades modules from CPAN. This script does not run on Windows.</td>
</tr>
<tr class="odd">
<th><a href="./jobqueue.html">jobqueue</a></th>
<td>Runs jobs in the background for Bugzilla.</td>
</tr>
<tr class="even">
<th><a href="./migrate.html">migrate</a></th>
<td>A script to migrate from other bug-trackers to Bugzilla.</td>
</tr>
<tr class="odd">
<th><a href="./sanitycheck.html">sanitycheck</a></th>
<td>Perl script to perform a sanity check at the command line</td>
</tr>
</table></dd>
<dt><a name="Modules">Modules</a></dt>
<dd>
<table class="pod_desc_table">
<tr class="even">
<th><a href="./Bugzilla.html">Bugzilla</a></th>
<td>Semi-persistent collection of various objects used by scripts and modules</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Attachment.html">Bugzilla::Attachment</a></th>
<td>Bugzilla attachment class.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Auth.html">Bugzilla::Auth</a></th>
<td>An object that authenticates the login credentials for a user.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Auth/Login.html">Bugzilla::Auth::Login</a></th>
<td>Gets username/password data from the user.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Auth/Verify.html">Bugzilla::Auth::Verify</a></th>
<td>An object that verifies usernames and passwords.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/CGI.html">Bugzilla::CGI</a></th>
<td>CGI handling for Bugzilla</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Classification.html">Bugzilla::Classification</a></th>
<td>Bugzilla classification class.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Comment.html">Bugzilla::Comment</a></th>
<td>A Comment for a given bug</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Component.html">Bugzilla::Component</a></th>
<td>Bugzilla product component class.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Config.html">Bugzilla::Config</a></th>
<td>Configuration parameters for Bugzilla</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Config/Common.html">Bugzilla::Config::Common</a></th>
<td>Parameter checking functions</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/DB.html">Bugzilla::DB</a></th>
<td>Database access routines, using DBI</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/DB/Mysql.html">Bugzilla::DB::Mysql</a></th>
<td>Bugzilla database compatibility layer for MySQL</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/DB/Oracle.html">Bugzilla::DB::Oracle</a></th>
<td>Bugzilla database compatibility layer for Oracle</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/DB/Pg.html">Bugzilla::DB::Pg</a></th>
<td>Bugzilla database compatibility layer for PostgreSQL</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/DB/Schema.html">Bugzilla::DB::Schema</a></th>
<td>Abstract database schema for Bugzilla</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/DB/Sqlite.html">Bugzilla::DB::Sqlite</a></th>
<td>Bugzilla database compatibility layer for SQLite</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Error.html">Bugzilla::Error</a></th>
<td>Error handling utilities for Bugzilla</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Extension.html">Bugzilla::Extension</a></th>
<td>Base class for Bugzilla Extensions.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Field.html">Bugzilla::Field</a></th>
<td>a particular piece of information about bugs and useful routines for form field manipulation</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Field/Choice.html">Bugzilla::Field::Choice</a></th>
<td>A legal value for a <select>-type field.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Field/ChoiceInterface.html">Bugzilla::Field::ChoiceInterface</a></th>
<td>Makes an object act like a Bugzilla::Field::Choice.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Flag.html">Bugzilla::Flag</a></th>
<td>A module to deal with Bugzilla flag values.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/FlagType.html">Bugzilla::FlagType</a></th>
<td>A module to deal with Bugzilla flag types.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Group.html">Bugzilla::Group</a></th>
<td>Bugzilla group class.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Hook.html">Bugzilla::Hook</a></th>
<td>Extendable extension hooks for Bugzilla code</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Install.html">Bugzilla::Install</a></th>
<td>Functions and variables having to do with installation.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Install/CPAN.html">Bugzilla::Install::CPAN</a></th>
<td>Routines to install Perl modules from CPAN.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Install/DB.html">Bugzilla::Install::DB</a></th>
<td>Fix up the database during installation.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Install/Filesystem.html">Bugzilla::Install::Filesystem</a></th>
<td>Fix up the filesystem during installation.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Install/Localconfig.html">Bugzilla::Install::Localconfig</a></th>
<td></td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Install/Requirements.html">Bugzilla::Install::Requirements</a></th>
<td>Functions and variables dealing with Bugzilla's perl-module requirements.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Install/Util.html">Bugzilla::Install::Util</a></th>
<td>Utility functions that are useful both during installation and afterwards.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/JobQueue.html">Bugzilla::JobQueue</a></th>
<td>Interface between Bugzilla and TheSchwartz.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/JobQueue/Runner.html">Bugzilla::JobQueue::Runner</a></th>
<td>A class representing the daemon that runs the job queue.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Keyword.html">Bugzilla::Keyword</a></th>
<td>A Keyword that can be added to a bug.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Migrate.html">Bugzilla::Migrate</a></th>
<td>Functions to migrate from other databases</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Milestone.html">Bugzilla::Milestone</a></th>
<td>Bugzilla product milestone class.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Object.html">Bugzilla::Object</a></th>
<td>A base class for objects in Bugzilla.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Product.html">Bugzilla::Product</a></th>
<td>Bugzilla product class.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Search/Recent.html">Bugzilla::Search::Recent</a></th>
<td>A search recently run by a logged-in user.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Search/Saved.html">Bugzilla::Search::Saved</a></th>
<td>A saved search</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Status.html">Bugzilla::Status</a></th>
<td>Bug status class.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Template.html">Bugzilla::Template</a></th>
<td>Wrapper around the Template Toolkit Template object</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Template/Plugin/Bugzilla.html">Bugzilla::Template::Plugin::Bugzilla</a></th>
<td></td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Template/Plugin/Hook.html">Bugzilla::Template::Plugin::Hook</a></th>
<td></td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Template/Plugin/User.html">Bugzilla::Template::Plugin::User</a></th>
<td></td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Token.html">Bugzilla::Token</a></th>
<td>Provides different routines to manage tokens.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Update.html">Bugzilla::Update</a></th>
<td>Update routines for Bugzilla</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/User.html">Bugzilla::User</a></th>
<td>Object for a Bugzilla user</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/User/Setting.html">Bugzilla::User::Setting</a></th>
<td>Object for a user preference setting</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/User/Setting/Lang.html">Bugzilla::User::Setting::Lang</a></th>
<td>Object for a user preference setting for preferred language</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/User/Setting/Skin.html">Bugzilla::User::Setting::Skin</a></th>
<td>Object for a user preference setting for skins</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/User/Setting/Timezone.html">Bugzilla::User::Setting::Timezone</a></th>
<td>Object for a user preference setting for desired timezone</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Util.html">Bugzilla::Util</a></th>
<td>Generic utility functions for bugzilla</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Version.html">Bugzilla::Version</a></th>
<td>Bugzilla product version class.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/WebService.html">Bugzilla::WebService</a></th>
<td>The Web Service interface to Bugzilla</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/WebService/Bug.html">Bugzilla::WebService::Bug</a></th>
<td>The API for creating, changing, and getting the details of bugs.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/WebService/Bugzilla.html">Bugzilla::WebService::Bugzilla</a></th>
<td>Global functions for the webservice interface.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/WebService/Group.html">Bugzilla::WebService::Group</a></th>
<td>The API for creating, changing, and getting information about Groups.</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/WebService/Product.html">Bugzilla::WebService::Product</a></th>
<td>The Product API</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/WebService/Server/JSONRPC.html">Bugzilla::WebService::Server::JSONRPC</a></th>
<td>The JSON-RPC Interface to Bugzilla</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/WebService/Server/XMLRPC.html">Bugzilla::WebService::Server::XMLRPC</a></th>
<td>The XML-RPC Interface to Bugzilla</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/WebService/User.html">Bugzilla::WebService::User</a></th>
<td>The User Account and Login API</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/WebService/Util.html">Bugzilla::WebService::Util</a></th>
<td></td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Whine.html">Bugzilla::Whine</a></th>
<td>A Whine event</td>
</tr>
<tr class="even">
<th><a href="./Bugzilla/Whine/Query.html">Bugzilla::Whine::Query</a></th>
<td>A query object used by Bugzilla::Whine.</td>
</tr>
<tr class="odd">
<th><a href="./Bugzilla/Whine/Schedule.html">Bugzilla::Whine::Schedule</a></th>
<td>A schedule object used by Bugzilla::Whine.</td>
</tr>
</table></dd>
</dl>
</body></html>
