Contains methods to import and upload files into the Files section of the conference room and the personal drive of any user
WSDL sample Url: http://localhost:5080/openmeetings/services/FileService?wsdl
Import file from external source to upload a file to a room-drive you specify: externalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 0 parentFolderId = 0 to upload a file to a private-drive you specify: externalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 1 parentFolderId = -2
Return Type: org.apache.openmeetings.util.process.FileImportError[]
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The logged in session id with minimum webservice level |
String | externalUserId | the external user id => If the file should goto a private section of any user, this number needs to be set |
Long | externalFileId | the external file-type to identify the file later |
String | externalType | the name of the external system |
Long | room_id | the room Id, if the file goes to the private folder of an user, you can set a random number here |
boolean | isOwner | specify a 1/true AND parentFolderId==-2 to make the file goto the private section |
String | path | http-path where we can grab the file from, the file has to be accessible from the OpenMeetings server |
Long | parentFolderId | specify a parentFolderId==-2 AND isOwner == 1/true AND to make the file goto the private section |
String | fileSystemName | the filename => Important WITH file extension! |
Import file from external source to upload a file to a room-drive you specify: internalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 0 parentFolderId = 0 to upload a file to a private-drive you specify: internalUserId, user if of openmeetings user for which we upload the file room_id = openmeetings room id isOwner = 1 parentFolderId = -2
Return Type: org.apache.openmeetings.util.process.FileImportError[]
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | internalUserId | the openmeetings user id => If the file should goto a private section of any user, this number needs to be se |
Long | externalFileId | the external file-type to identify the file later |
String | externalType | the name of the external system |
Long | room_id | the room Id, if the file goes to the private folder of an user, you can set a random number here |
boolean | isOwner | specify a 1/true AND parentFolderId==-2 to make the file goto the private section |
String | path | http-path where we can grab the file from, the file has to be accessible from the OpenMeetings server |
Long | parentFolderId | specify a parentFolderId==-2 AND isOwner == 1/true AND to make the file goto the private section |
String | fileSystemName | the filename => Important WITH file extension! |
to add a folder to the private drive, set parentFileExplorerItemId = 0 and isOwner to 1/true and externalUserId/externalUserType to a valid user
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
String | externalUserId | the external file-type to identify the file later |
Long | parentFileExplorerItemId | |
String | folderName | the name of the folder |
Long | room_id | the room Id, if the file goes to the private folder of an user, you can set a random number here |
Boolean | isOwner | specify a 1/true AND parentFolderId==-2 to make the file goto the private section |
Long | externalFilesid | the external file-type to identify the file later |
String | externalType | the name of the external system |
to add a folder to the private drive, set parentFileExplorerItemId = 0 and isOwner to 1/true and userId to a valid user
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | userId | the openmeetings user id |
Long | parentFileExplorerItemId | specify a parentFolderId==-2 AND isOwner == 1/true AND to make the file goto the private section |
String | folderName | the name of the folder |
Long | room_id | the room Id, if the file goes to the private folder of an user, you can set a random number here |
Boolean | isOwner | specify a 1/true AND parentFolderId==-2 to make the file goto the private section |
Long | externalFilesid | the external file-type to identify the file later |
String | externalType | the name of the external system |
Add a folder by the current user - similar to RTMP Call
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | parentFileExplorerItemId | parent folder id |
String | fileName | the file name |
Long | room_id | the room id |
Boolean | isOwner |
deletes a file by its external Id and type
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | externalFilesid | the od of the file or folder |
String | externalType | the externalType |
deletes files or folders based on it id
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | fileExplorerItemId | the id of the file or folder |
deletes files or folders based on it id
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | fileExplorerItemId | the id of the file or folder |
Get available import File Extension allowed during import
Return Type: java.lang.String[]
Params:
No ParamsGet a LibraryPresentation-Object for a certain file
Return Type: org.apache.openmeetings.db.dto.file.LibraryPresentation
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | |
String | parentFolder |
Get a File Explorer Object by a given Room and owner id
Return Type: org.apache.openmeetings.db.dto.file.FileExplorerObject
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | room_id | Room id |
Long | owner_id | Owner id |
Get a File Explorer Object by a given Room
Return Type: org.apache.openmeetings.db.dto.file.FileExplorerObject
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | room_id | Room Id |
Get FileExplorerItem list by parent folder
Return Type: org.apache.openmeetings.db.entity.file.FileExplorerItem[]
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | The SID of the User. This SID must be marked as logged in |
Long | parentFileExplorerItemId | the parent folder id |
Long | room_id | the room id |
Boolean | isOwner | true if its a private drive |
Long | owner_id | the owner id |
Get FileExplorerItem[] by parent and owner id
Return Type: org.apache.openmeetings.db.entity.file.FileExplorerItem[]
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | SID The SID of the User. This SID must be marked as logged in |
Long | parentFileExplorerItemId | the parent folder id |
Long | room_id | the room id |
Boolean | isOwner | true to request private drive |
update a file or folder name
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | SID The SID of the User. This SID must be marked as logged in |
Long | fileExplorerItemId | file or folder id |
String | fileName | new file or folder name |
update a file or folder name
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | SID The SID of the User. This SID must be marked as logged in |
Long | fileExplorerItemId | file or folder id |
String | fileName | new file or folder name |
move a file or folder
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | SID The SID of the User. This SID must be marked as logged in |
Long | fileExplorerItemId | current file or folder id to be moved |
Long | newParentFileExplorerItemId | new parent folder id |
Long | room_id | room id |
Boolean | isOwner | if true owner id will be set |
Boolean | moveToHome | if true move to private drive |
Long | owner_id | owner id |
move a file or folder
Return Type: java.lang.Long
Params:
Type | Fieldname | Description |
---|---|---|
String | SID | SID The SID of the User. This SID must be marked as logged in |
Long | fileExplorerItemId | current file or folder id to be moved |
Long | newParentFileExplorerItemId | new parent folder id |
Long | room_id | room id |
Boolean | isOwner | if true owner id will be set |
Boolean | moveToHome | move to private drive |