Merge pull request #5759 from FinnStutzenstein/updateMediafileInterface
Update mediaservice interface
This commit is contained in:
commit
bbb355cc05
@ -1,16 +1,35 @@
|
|||||||
/**
|
/**
|
||||||
* Saves a file (encoded as base64) into this service.
|
* Saves a mediafile (encoded as base64) into this service.
|
||||||
*
|
*
|
||||||
* Technical:
|
* Technical:
|
||||||
* POST to /internal/media/upload/ with JSON payload.
|
* POST to /internal/media/upload_mediafile/ with JSON payload.
|
||||||
* Returns 200 on success, 4xx on Errors with a message in the payload.
|
* Returns 200 on success, 4xx on errors with a message in the payload.
|
||||||
*/
|
*/
|
||||||
upload(file: string, id: Id, mimetype: string): {message: string} | void
|
upload_mediafile(file: string, id: Id, mimetype: string): {message: string} | void
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves a mediafile given by the meeting and the path of the file.
|
* Saves a resource (encoded as base64) into this service.
|
||||||
*
|
*
|
||||||
* Technical:
|
* Technical:
|
||||||
* GET to /system/media/get/<meeting_id>/<path>
|
* POST to /internal/media/upload_resource/ with JSON payload.
|
||||||
|
* Returns 200 on success, 4xx on errors with a message in the payload.
|
||||||
*/
|
*/
|
||||||
get(meeting_id: Id, path: string): Blob
|
upload_resource(file: string, id: Id, mimetype: string): {message: string} | void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a mediafile given by it's id.
|
||||||
|
*
|
||||||
|
* Technical:
|
||||||
|
* GET to /system/media/get/<mediafile_id>
|
||||||
|
* Returns 200 on success and 404, if the resource does not exist
|
||||||
|
*/
|
||||||
|
get(mediafile_id: Id): Blob
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieves a resource given by it's id.
|
||||||
|
*
|
||||||
|
* Technical:
|
||||||
|
* GET to /system/media/get_resource/<resource_id>
|
||||||
|
* Returns 200 on success and 404, if the resource does not exist
|
||||||
|
*/
|
||||||
|
get(resource_id: Id): Blob
|
Loading…
Reference in New Issue
Block a user