@Produces(value="application/json") @Path(value="/file") public class FileWebService extends Object
Constructor and Description |
---|
FileWebService() |
Modifier and Type | Method and Description |
---|---|
FileExplorerItemDTO |
add(String sid,
FileExplorerItemDTO file,
InputStream stream)
to add a folder to the private drive, set parentFileExplorerItemId = 0 and isOwner to 1/true and
externalUserId/externalUserType to a valid user
|
ServiceResult |
delete(String sid,
Long id)
deletes files or folders based on it id
|
ServiceResult |
deleteExternal(String sid,
String externalType,
String externalId)
deletes a file by its external Id and type
|
FileExplorerObject |
getRoom(String sid,
long roomId)
Get a File Explorer Object by a given Room
|
List<FileExplorerItemDTO> |
getRoomByParent(String sid,
long roomId,
long parentId)
Get list of
FileExplorerItemDTO by parent |
FileExplorerItemDTO |
move(String sid,
long id,
long roomId,
long parentId)
move a file or folder
|
FileExplorerItemDTO |
rename(String sid,
long id,
String name)
update a file or folder name
|
@DELETE @Path(value="/{id}") public ServiceResult delete(@QueryParam(value="sid") String sid, @PathParam(value="id") Long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as logged inid
- the id of the file or folderorg.apache.openmeetings.webservice.error.ServiceException
@DELETE @Path(value="/{externaltype}/{externalid}") public ServiceResult deleteExternal(@QueryParam(value="sid") String sid, @PathParam(value="externaltype") String externalType, @PathParam(value="externalid") String externalId)
sid
- The SID of the User. This SID must be marked as logged inexternalId
- the od of the file or folderexternalType
- the externalType@POST @Consumes(value="multipart/form-data") @Path(value="/") public FileExplorerItemDTO add(@QueryParam(value="sid") String sid, FileExplorerItemDTO file, InputStream stream) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as logged infile
- the The file to be addedstream
- the The file to be addedorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/room/{id}") public FileExplorerObject getRoom(@QueryParam(value="sid") String sid, @PathParam(value="id") long roomId) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as logged inroomId
- Room Idorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/room/{id}/{parent}") public List<FileExplorerItemDTO> getRoomByParent(@QueryParam(value="sid") String sid, @PathParam(value="id") long roomId, @PathParam(value="parent") long parentId) throws org.apache.openmeetings.webservice.error.ServiceException
FileExplorerItemDTO
by parentsid
- SID The SID of the User. This SID must be marked as logged inparentId
- the parent folder idroomId
- the room idorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/rename/{id}/{name}") public FileExplorerItemDTO rename(@QueryParam(value="sid") String sid, @PathParam(value="id") long id, @PathParam(value="name") String name) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- SID The SID of the User. This SID must be marked as logged inid
- file or folder idname
- new file or folder nameorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/move/{roomid}/{id}/{parentid}") public FileExplorerItemDTO move(@QueryParam(value="sid") String sid, @PathParam(value="id") long id, @PathParam(value="roomid") long roomId, @PathParam(value="parentid") long parentId) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- SID The SID of the User. This SID must be marked as logged inid
- current file or folder id to be movedparentId
- new parent folder idorg.apache.openmeetings.webservice.error.ServiceException
Copyright © 2012–2017 Apache Software Foundation. All rights reserved.