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>
OnlineUpdateCallbacks.ycp
</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>
OnlineUpdateCallbacks.ycp
</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>
OnlineUpdateCallbacks.ycp
</h1>
</td>
</tr>
<tr>
<td></td>
</tr>
<tr>
<td>
<ul>
<li>Cornelius Schumacher <cschum@suse.de></li>
<li> Purpose: provides the Callbacks for the online update</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>OnlineUpdateDialogs</li>
<li>PackageCallbacks</li>
<li>Popup</li>
<li>Report</li>
</ul>
<h1>Global Functions</h1>
<ul>
<li>
<a href="#DonePackage">DonePackage (integer error, string reason)</a>
</li>
<li>
<a href="#DoneProvide">DoneProvide (integer error, string reason, string name)</a>
</li>
<li>
<a href="#FinishLine">FinishLine (boolean line)</a>
</li>
<li>
<a href="#PatchProgressCallback">PatchProgressCallback (integer num)</a>
</li>
<li>
<a href="#ProblemDeltaApply">ProblemDeltaApply (string description)</a>
</li>
<li>
<a href="#ProblemDeltaDownload">ProblemDeltaDownload (string description)</a>
</li>
<li>
<a href="#ProblemPatchDownload">ProblemPatchDownload (string description)</a>
</li>
<li>
<a href="#ProgressDeltaApply">ProgressDeltaApply (integer num)</a>
</li>
<li>
<a href="#ProgressDeltaDownload">ProgressDeltaDownload (integer num)</a>
</li>
<li>
<a href="#ProgressLog">ProgressLog (string text)</a>
</li>
<li>
<a href="#ProgressPatchDownload">ProgressPatchDownload (integer num)</a>
</li>
<li>
<a href="#RefreshSources">RefreshSources (list<map> sources)</a>
</li>
<li>
<a href="#RegisterOnlineUpdateCallbacks">RegisterOnlineUpdateCallbacks ()</a>
</li>
<li>
<a href="#StartDeltaDownload">StartDeltaDownload (string name, integer download_size)</a>
</li>
<li>
<a href="#StartPackage">StartPackage (string name, string summary, integer installsize, boolean is_delete)</a>
</li>
<li>
<a href="#StartPatchDownload">StartPatchDownload (string name, integer download_size)</a>
</li>
<li>
<a href="#StartProvide">StartProvide (string name, integer archivesize, boolean remote)</a>
</li>
</ul>
</td>
</tr>
</table>
</div>
<p />
<div class="sigbox">
<span class="sig" id="PatchProgressCallback">global
<b>PatchProgressCallback (integer num)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Callback for patch (resp. delta rpm) progress widget.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">num</span>
</td>
<td class="descbox">position of progress widget (0 to 100)</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProgressLog">global
<b>ProgressLog (string text)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
add a text to the installation progress log</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">text</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StartProvide">global
<b>StartProvide (string name, integer archivesize, boolean remote)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Callback for starting download of a package.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">name</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">archivesize</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">remote</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StartPackage">global
<b>StartPackage (string name, string summary, integer installsize, boolean is_delete)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Callback for starting installation of a package.</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">name</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">summary</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">installsize</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">is_delete</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="FinishLine">global
<b>FinishLine (boolean line)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
Callback for finishing an action in the log</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">line</span>
</td>
<td class="descbox">true if we are adding to the end of line</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="DonePackage">global
<b>DonePackage (integer error, string reason)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
callback for 'package installed' action</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">error</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">reason</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="DoneProvide">global
<b>DoneProvide (integer error, string reason, string name)
<span class="a"> -> </span>
<span class="t">string</span>
</b>
</span>
</div>
<p>
callback for 'package provided' action</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">error</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">reason</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">name</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StartDeltaDownload">global
<b>StartDeltaDownload (string name, integer download_size)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
callback for start of delta download</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">name</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">download_size</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProgressDeltaDownload">global
<b>ProgressDeltaDownload (integer num)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
callback for delta download progress</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">num</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">abort the download?</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProblemDeltaDownload">global
<b>ProblemDeltaDownload (string description)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
callback for problem during downloading delta</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProgressDeltaApply">global
<b>ProgressDeltaApply (integer num)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
progress of applying delta
(cannot be aborted)</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">num</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProblemDeltaApply">global
<b>ProblemDeltaApply (string description)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
callback for problem during aplying delta</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="StartPatchDownload">global
<b>StartPatchDownload (string name, integer download_size)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
callback for start of downloading patch</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">name</span>
</td>
<td class="descbox"></td>
</tr>
<tr>
<td class="pbox">
<span class="p">download_size</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProgressPatchDownload">global
<b>ProgressPatchDownload (integer num)
<span class="a"> -> </span>
<span class="t">boolean</span>
</b>
</span>
</div>
<p>
callback for path download progress</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">num</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">abort the download?</td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="ProblemPatchDownload">global
<b>ProblemPatchDownload (string description)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
callback for problem during aplying delta</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">description</span>
</td>
<td class="descbox"></td>
</tr>
</table>
</dd>
</dl>
<div class="sigbox">
<span class="sig" id="RegisterOnlineUpdateCallbacks">global
<b>RegisterOnlineUpdateCallbacks ()
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Constructor</p>
<div class="sigbox">
<span class="sig" id="RefreshSources">global
<b>RefreshSources (list<map> sources)
<span class="a"> -> </span>
<span class="t">void</span>
</b>
</span>
</div>
<p>
Refresh sources given by argument</p>
<dl>
<dt>
<b>Parameters:</b>
</dt>
<dd>
<table>
<tr>
<td class="pbox">
<span class="p">sources</span>
</td>
<td class="descbox"></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