| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FileWebService (Openmeetings Webservices 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.webservice, class: FileWebService"> |
| <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/FileWebService.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><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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.webservice</a></div> |
| <h1 title="Class FileWebService" class="title">Class FileWebService</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">org.apache.openmeetings.webservice.BaseWebService</a> |
| <div class="inheritance">org.apache.openmeetings.webservice.FileWebService</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Service("fileWebService") |
| @Produces("application/json") |
| @Path("/file") |
| </span><span class="modifiers">public class </span><span class="element-name type-name-label">FileWebService</span> |
| <span class="extends-implements">extends <a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">BaseWebService</a></span></div> |
| <div class="block">Contains methods to import and upload files into the Files section of the |
| conference room and the personal drive of any USER</div> |
| <dl class="notes"> |
| <dt>Author:</dt> |
| <dd>sebawagner</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.openmeetings.webservice.BaseWebService">Fields inherited from class org.apache.openmeetings.webservice.<a href="BaseWebService.html" title="class in org.apache.openmeetings.webservice">BaseWebService</a></h3> |
| <code><a href="BaseWebService.html#fileDao">fileDao</a>, <a href="BaseWebService.html#roomDao">roomDao</a>, <a href="BaseWebService.html#sessionDao">sessionDao</a>, <a href="BaseWebService.html#userDao">userDao</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">FileWebService</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(java.lang.String,org.apache.openmeetings.db.dto.file.FileItemDTO,java.io.InputStream)" class="member-name-link">add</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a> file, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">to add a folder to the private drive, set parentId = 0 and isOwner to 1/true and |
| externalUserId/externalUserType to a valid USER</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#delete(java.lang.String,java.lang.Long)" class="member-name-link">delete</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">deletes files or folders based on it id</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deleteExternal(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">deleteExternal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">deletes a file by its external Id and type</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllExternal(java.lang.String,java.lang.String)" class="member-name-link">getAllExternal</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get all files by external type</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileExplorerObject.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileExplorerObject</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoom(java.lang.String,long)" class="member-name-link">getRoom</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long roomId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get a File Explorer Object by a given ROOM</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoomByParent(java.lang.String,long,long)" class="member-name-link">getRoomByParent</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long roomId, |
| long parentId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get list of <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link"><code>FileItemDTO</code></a> by parent</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#move(java.lang.String,long,long,long)" class="member-name-link">move</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id, |
| long roomId, |
| long parentId)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">move a file or folder</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rename(java.lang.String,long,java.lang.String)" class="member-name-link">rename</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| long id, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">update a file or folder name</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>FileWebService</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">FileWebService</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="delete(java.lang.String,java.lang.Long)"> |
| <h3>delete</h3> |
| <div class="member-signature"><span class="annotations">@DELETE |
| @Path("/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">delete</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a> id)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">deletes files or folders based on it id</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>id</code> - the id of the file or folder</dd> |
| <dt>Returns:</dt> |
| <dd><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link"><code>ServiceResult</code></a> with result type</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteExternal(java.lang.String,java.lang.String,java.lang.String)"> |
| <h3>deleteExternal</h3> |
| <div class="member-signature"><span class="annotations">@DELETE |
| @Path("/{externaltype}/{externalid}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link">ServiceResult</a></span> <span class="element-name">deleteExternal</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("externaltype") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType, |
| @PathParam("externalid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">deletes a file by its external Id and type</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>externalType</code> - the externalType</dd> |
| <dd><code>externalId</code> - the id of the file or folder</dd> |
| <dt>Returns:</dt> |
| <dd><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/basic/ServiceResult.html" title="class or interface in org.apache.openmeetings.db.dto.basic" class="external-link"><code>ServiceResult</code></a> with result type</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(java.lang.String,org.apache.openmeetings.db.dto.file.FileItemDTO,java.io.InputStream)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="annotations">@POST |
| @Consumes("multipart/form-data") |
| @Path("/") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a></span> <span class="element-name">add</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a> file, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a> stream)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">to add a folder to the private drive, set parentId = 0 and isOwner to 1/true and |
| externalUserId/externalUserType to a valid USER</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>file</code> - the The file attributes to be added</dd> |
| <dd><code>stream</code> - the The file to be added</dd> |
| <dt>Returns:</dt> |
| <dd>- Object created</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllExternal(java.lang.String,java.lang.String)"> |
| <h3>getAllExternal</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/{externaltype}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a>></span> <span class="element-name">getAllExternal</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("externaltype") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> externalType)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Get all files by external type</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>externalType</code> - External type for file listing</dd> |
| <dt>Returns:</dt> |
| <dd>- the list of files for given external type</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoom(java.lang.String,long)"> |
| <h3>getRoom</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/room/{id}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileExplorerObject.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileExplorerObject</a></span> <span class="element-name">getRoom</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long roomId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Get a File Explorer Object by a given ROOM</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>roomId</code> - ROOM Id</dd> |
| <dt>Returns:</dt> |
| <dd>- File Explorer Object by a given ROOM</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRoomByParent(java.lang.String,long,long)"> |
| <h3>getRoomByParent</h3> |
| <div class="member-signature"><span class="annotations">@GET |
| @Path("/room/{id}/{parent}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a>></span> <span class="element-name">getRoomByParent</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long roomId, |
| @PathParam("parent") |
| long parentId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">Get list of <a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link"><code>FileItemDTO</code></a> by parent</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - SID The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>parentId</code> - the parent folder id</dd> |
| <dd><code>roomId</code> - the room id</dd> |
| <dt>Returns:</dt> |
| <dd>- list of file explorer items</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rename(java.lang.String,long,java.lang.String)"> |
| <h3>rename</h3> |
| <div class="member-signature"><span class="annotations">@POST |
| @Path("/rename/{id}/{name}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a></span> <span class="element-name">rename</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id, |
| @PathParam("name") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">update a file or folder name</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - SID The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>id</code> - file or folder id</dd> |
| <dd><code>name</code> - new file or folder name</dd> |
| <dt>Returns:</dt> |
| <dd>- resulting file object</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="move(java.lang.String,long,long,long)"> |
| <h3>move</h3> |
| <div class="member-signature"><span class="annotations">@POST |
| @Path("/move/{roomid}/{id}/{parentid}") |
| </span><span class="modifiers">public</span> <span class="return-type"><a href="https://openmeetings.apache.org/openmeetings-db/apidocs/org/apache/openmeetings/db/dto/file/FileItemDTO.html" title="class or interface in org.apache.openmeetings.db.dto.file" class="external-link">FileItemDTO</a></span> <span class="element-name">move</span><wbr><span class="parameters">(@QueryParam("sid") |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> sid, |
| @PathParam("id") |
| long id, |
| @PathParam("roomid") |
| long roomId, |
| @PathParam("parentid") |
| long parentId)</span> |
| throws <span class="exceptions"><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></span></div> |
| <div class="block">move a file or folder</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sid</code> - SID The SID of the User. This SID must be marked as logged in</dd> |
| <dd><code>id</code> - current file or folder id to be moved</dd> |
| <dd><code>roomId</code> - room this file need to be moved</dd> |
| <dd><code>parentId</code> - new parent folder id</dd> |
| <dt>Returns:</dt> |
| <dd>- resulting file object</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="error/ServiceException.html" title="class in org.apache.openmeetings.webservice.error">ServiceException</a></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> |
