<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>SIKISyncEvents Protocol Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1333)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html">Connect </a>
</h1>
<p id="developer-home">
<a href="../index.html">Siminov Software Solution LLP</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To…</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Instance Methods">
<option value="//api/name/onFinish:">- onFinish:</option>
<option value="//api/name/onQueue:">- onQueue:</option>
<option value="//api/name/onStart:">- onStart:</option>
<option value="//api/name/onTerminate:">- onTerminate:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">SIKISyncEvents Protocol Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Conforms to</th>
<td>NSObject</td>
</tr><tr>
<th>Declared in</th>
<td>SIKISyncEvents.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>It is a blue print for class which handles sync events</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/onStart:" title="onStart:"></a>
<h3 class="method-title"><code><a href="#//api/name/onStart:">– onStart:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This method is called then a Sync is started.</p>
<p><p> In this you can initialize resources related to Sync.
<p> Once OnStart has finished, Connect will call OnQueue.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)onStart:(id<SIKISyncRequest>)<em>syncRequest</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>syncRequest</code></th>
<td><p>ISyncRequest instance</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is called then a Sync is started.</p>
<p><p> In this you can initialize resources related to Sync.
<p> Once OnStart has finished, Connect will call OnQueue.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">SIKISyncEvents.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/onQueue:" title="onQueue:"></a>
<h3 class="method-title"><code><a href="#//api/name/onQueue:">– onQueue:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This method is called then the Sync request is added to the Queue.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)onQueue:(id<SIKISyncRequest>)<em>syncRequest</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>syncRequest</code></th>
<td><p>ISyncRequest instance</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is called then the Sync request is added to the Queue.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">SIKISyncEvents.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/onFinish:" title="onFinish:"></a>
<h3 class="method-title"><code><a href="#//api/name/onFinish:">– onFinish:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This method is called then Sync request completes its all synchronization data with web service.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)onFinish:(id<SIKISyncRequest>)<em>syncRequest</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>syncRequest</code></th>
<td><p>ISyncRequest instance</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is called then Sync request completes its all synchronization data with web service.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">SIKISyncEvents.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/onTerminate:" title="onTerminate:"></a>
<h3 class="method-title"><code><a href="#//api/name/onTerminate:">– onTerminate:</a></code>
<span class="task-item-suffix">required method</span></h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>This method is called if there is any error/exception while synchronizing data with web service</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)onTerminate:(id<SIKISyncRequest>)<em>syncRequest</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>syncRequest</code></th>
<td><p>ISyncRequest instance</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This method is called if there is any error/exception while synchronizing data with web service</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">SIKISyncEvents.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright © 2016 Siminov Software Solution LLP. All rights reserved. Updated: 2016-01-04</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1333)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>