ACC SHELL
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
<head>
<title>
WebpinPackageSearch
</title>
<style type="text/css">body { background-color: #c8c8c8 }
h1 { color: #e00000 }
table { width: 100%/ border: none }
img { border: 0px }
.sigbox { background-color: #ffc080; border: solid thin #f96500 }
.sig { font: larger monospace }
.padtbl { background-color: #ffc080; padding: 10px; margin: 10px }
/* arrow */
.a { color: #606060 }
/* type, parameter */
.t, .p { color: #c05000 }
.pbox { width: 20% }
.descbox { }
.right { align: right }
.header {}
.footer { clear: both}
.menu { width: 10%; float: left }
.main { width: 90%; float: left }
</style>
</head>
<body>
<div class="header">
<i>YaST2 Developers Documentation:</i>
<a href="index.html">
<b>
WebpinPackageSearch
</b>
</a>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
<hr />
</div>
<div class="menu">
<img alt="YaST" src="/usr/share/doc/packages/yast2-devtools/images/yast2-half.png" />
<br />
<br />
<a href="index.html">functions</a>
<br />
<a href="files.html">files</a>
<br />
<a href="intro.html">intro</a>
</div>
<div class="main">
<div class="sigbox">
<table class="padtbl">
<tr>
<td>
<h1>
WebpinPackageSearch
</h1>
</td>
<td class="filecell">
WebpinPackageSearch.ycp
</td>
</tr>
<tr>
<td>
YaST API to api.opensuse-community.org
</td>
</tr>
<tr>
<td>
<ul>
<li> Lukas Ocilka <locilka@suse.cz></li>
<li> Katarina Machalkova <kmachalkova@suse.cz></li>
</ul>
</td>
</tr>
<tr>
<td>
<p>This module has an unstable interface.</p>
</td>
</tr>
</table>
<table class="padtbl">
<tr>
<td>
<h1>Imports</h1>
<ul>
<li>Arch</li>
<li>Directory</li>
<li>FileUtils</li>
<li>HTTP</li>
<li>SuSERelease</li>
<li>URL</li>
<li>XML</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#GetBaseSearchURL">GetBaseSearchURL ()</a>
</li>
<li>
<a href="#MatchesCurrentArchitecture">MatchesCurrentArchitecture (list <string> archs_to_check)</a>
</li>
<li>
<a href="#PrepareOneClickInstallDescription">PrepareOneClickInstallDescription (list <map> packages_to_install, string save_to_file)</a>
</li>
<li>
<a href="#SearchForPackages">SearchForPackages (string search_for, string distribution, map <string, boolean> search_in)</a>
</li>
<li>
<a href="#SetBaseSearchURL">SetBaseSearchURL (string new_base_url)</a>
</li>
</ul>
<h1>Local Variables</h1>
<ul>
<li>
<a href="#base_url">base_url</a>
</li>
<li>
<a href="#deps">deps</a>
</li>
</ul>
<h1>Local Functions</h1>
<ul>
<li>
<a href="#GuessCurrentDistribution">GuessCurrentDistribution ()</a>
</li>
<li>
<a href="#ModifyDistro">ModifyDistro (string distro)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="base_url">local
<b>base_url
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Base search URL, default is "http://api.opensuse-community.org/searchservice/"</p>
<div class="sigbox">
<span class="sig" id="SetBaseSearchURL">global
<b>SetBaseSearchURL (string new_base_url)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Sets base search URL
WARNING: Use this only if you know what you are doing!</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">new_base_url</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GetBaseSearchURL">global
<b>GetBaseSearchURL ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Returns base search URL</p>
<div class="sigbox">
<span class="sig" id="deps">local
<b>deps
<span class="a"> -> </span>
<span class="t">list <list <string> ></span>
</b>
</span>
</div>
<p>
List of architecture dependencies. Every row contains one list
of dependencies sortred from left (the newest) to right (the oldest).
Architectures are backward-compatible.</p>
<div class="sigbox">
<span class="sig" id="MatchesCurrentArchitecture">global
<b>MatchesCurrentArchitecture (list <string> archs_to_check)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Returns whether the current architecture matches the list of architectures
got as a parameter. The current architecture is backward compatible, so
also dependencies are taken into account.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">archs_to_check</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">whether they match the current architecture
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
// current architecture is "i386"
MatchesCurrentArchitecture (["noarch", "ppc", "i386"]) -> true
MatchesCurrentArchitecture (["noarch"]) -> true
MatchesCurrentArchitecture (["x86_64"]) -> false
MatchesCurrentArchitecture (["ppc"]) -> false</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="GuessCurrentDistribution">local
<b>GuessCurrentDistribution ()
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Guesses the current distribution installed</p>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">distribution (Webpin format)
// Installed openSUSE 11.0
GuessCurrentDistribution() -> "openSUSE_110"</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ModifyDistro">local
<b>ModifyDistro (string distro)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
Changes the Webpin distro format to OneClickInstall format.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">distro</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">modified distro
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
ModifyDistro ("openSUSE_110") -> "openSUSE 11.0"</pre></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="PrepareOneClickInstallDescription">global
<b>PrepareOneClickInstallDescription (list <map> packages_to_install, string save_to_file)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Writes XML configuration file for OnleClickInstall client.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">packages_to_install</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">save_to_file</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Return value:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="t" />
</td>
<td class="descbox">if successful
</td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>See</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><a href="#SearchForPackages() for the format of <map> package_to_install">SearchForPackages() for the format of <map> package_to_install</a></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="SearchForPackages">global
<b>SearchForPackages (string search_for, string distribution, map <string, boolean> search_in)
<span class="a"> -> </span>
<span class="t">list <map></span>
</b>
</span>
</div>
<p>
Searches for packages using Webpin XML API.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">search_for</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">distribution</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">search_in</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<dl>
<dt>
<b>Example</b>
</dt>
<dd>
<table>
<tr>
<td align="left" valign="top"><pre>
SearchForPackages (
"desktop",
nil,
$[
"name" : true,
"description" : true,
"contents" : false,
]
)
->
[
...
$[
"archs":[
"ppc"
],
"checksum":"e0cbdbf03ce47dfd5c5f885b86706ddfa023d8dc",
"distro":"openSUSE_110",
"name":"xfce4-desktop",
"priority":"5",
"repoURL":"http://download.opensuse.org/distribution/11.0/repo/oss/suse",
"summary":"Desktop manager for the Xfce Desktop Environment",
"version":"4.4.2"
],
...
]</pre></td>
</tr>
</table>
</dd>
</dl>
</div>
<div class="footer">
<hr />
<i>YaST2 Developers Documentation</i>
<img class="right" alt="" src="/usr/share/doc/packages/yast2-devtools/images/yast2-mini.png" />
</div>
</body>
</html>
ACC SHELL 2018