| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CalendarHandler (Openmeetings Service 7.2.0 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.openmeetings.service.calendar.caldav.handler, interface: CalendarHandler"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/CalendarHandler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.openmeetings.service.calendar.caldav.handler</a></div> |
| <h1 title="Interface CalendarHandler" class="title">Interface CalendarHandler</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractCalendarHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">AbstractCalendarHandler</a></code>, <code><a href="CtagHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">CtagHandler</a></code>, <code><a href="EtagsHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">EtagsHandler</a></code>, <code><a href="MultigetHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">MultigetHandler</a></code>, <code><a href="WebDAVSyncHandler.html" title="class in org.apache.openmeetings.service.calendar.caldav.handler">WebDAVSyncHandler</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">CalendarHandler</span></div> |
| <div class="block">SyncHandler Interface specifies if the class is Sync Handler. |
| The classes which implement this class can be used to |
| update items depending on the type of syncing necessary. |
| <p> |
| This is a helper class to help Syncing of CalDAV calendars. |
| <p> |
| There are currently three types of Sync Handlers. Namely: |
| <ul> |
| <li>ETAGs Sync</li> |
| <li>CTAGs Sync (Similar to ETAGs but an additional step is necessary)</li> |
| <li>WebDAV-Sync Report</li> |
| <li>Calendar-Multiget Report</li> |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#deleteItem(org.apache.openmeetings.db.entity.calendar.Appointment)" class="member-name-link">deleteItem</a><wbr>(<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Delete Appointment on the server.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#syncItems()" class="member-name-link">syncItems</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Function to update all items in the CalDAV calendar.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#updateItem(org.apache.openmeetings.db.entity.calendar.Appointment)" class="member-name-link">updateItem</a><wbr>(<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Function for create/updating multiple appointment on the server.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="syncItems()"> |
| <h3>syncItems</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/OmCalendar.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">OmCalendar</a></span> <span class="element-name">syncItems</span>()</div> |
| <div class="block">Function to update all items in the CalDAV calendar. The owner of the appointments |
| created are the same as the owner of the calendar.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Returns the updated calendar after updation of all events.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="updateItem(org.apache.openmeetings.db.entity.calendar.Appointment)"> |
| <h3>updateItem</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">updateItem</span><wbr><span class="parameters">(<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</span></div> |
| <div class="block">Function for create/updating multiple appointment on the server. |
| Performs modification alongside of creation new events on the server.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>appointment</code> - Appointment to create/update.</dd> |
| <dt>Returns:</dt> |
| <dd><code>True</code> when the updation is a success else <code>False</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteItem(org.apache.openmeetings.db.entity.calendar.Appointment)"> |
| <h3>deleteItem</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">deleteItem</span><wbr><span class="parameters">(<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/entity/calendar/Appointment.html" title="class or interface in org.apache.openmeetings.db.entity.calendar" class="external-link">Appointment</a> appointment)</span></div> |
| <div class="block">Delete Appointment on the server.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>appointment</code> - Appointment to delete</dd> |
| <dt>Returns:</dt> |
| <dd><code>True</code> when the deletion is a success else <code>False</code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012–2023 <a href="https://apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |