class Kaltura::KalturaDocumentsService
Document service lets you upload and manage document files
Public Class Methods
Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 490 def initialize(client) super(client) end
Public Instance Methods
Copy entry into new entry @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 496 def add_from_entry(source_entry_id, document_entry=KalturaNotImplemented, source_flavor_params_id=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'sourceEntryId', source_entry_id) client.add_param(kparams, 'documentEntry', document_entry) client.add_param(kparams, 'sourceFlavorParamsId', source_flavor_params_id) client.queue_service_action_call('document_documents', 'addFromEntry', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Copy flavor asset into new entry @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 510 def add_from_flavor_asset(source_flavor_asset_id, document_entry=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'sourceFlavorAssetId', source_flavor_asset_id) client.add_param(kparams, 'documentEntry', document_entry) client.queue_service_action_call('document_documents', 'addFromFlavorAsset', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Add new document entry after the specific document file was uploaded and the upload token id exists @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 523 def add_from_uploaded_file(document_entry, upload_token_id) kparams = {} client.add_param(kparams, 'documentEntry', document_entry) client.add_param(kparams, 'uploadTokenId', upload_token_id) client.queue_service_action_call('document_documents', 'addFromUploadedFile', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Approves document replacement @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 536 def approve_replace(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('document_documents', 'approveReplace', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Cancels document replacement @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 548 def cancel_replace(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('document_documents', 'cancelReplace', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Convert entry @return [bigint]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 560 def convert(entry_id, conversion_profile_id=KalturaNotImplemented, dynamic_conversion_attributes=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'conversionProfileId', conversion_profile_id) client.add_param(kparams, 'dynamicConversionAttributes', dynamic_conversion_attributes) client.queue_service_action_call('document_documents', 'convert', 'bigint', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
This will queue a batch job for converting the document file to swf
Returns the URL where the new swf will be available
@return [string]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 575 def convert_ppt_to_swf(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('document_documents', 'convertPptToSwf', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Delete a document entry. @return []
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 587 def delete(entry_id) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.queue_service_action_call('document_documents', 'delete', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Get document entry by ID. @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 599 def get(entry_id, version=-1) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'version', version) client.queue_service_action_call('document_documents', 'get', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
List document entries by filter with paging support. @return [KalturaDocumentListResponse]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 612 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('document_documents', 'list', 'KalturaDocumentListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Serves the file content @return [file]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 625 def serve(entry_id, flavor_asset_id=KalturaNotImplemented, force_proxy=false) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'flavorAssetId', flavor_asset_id) client.add_param(kparams, 'forceProxy', force_proxy) client.queue_service_action_call('document_documents', 'serve', 'file', kparams) return client.get_serve_url() end
Serves the file content @return [file]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 636 def serve_by_flavor_params_id(entry_id, flavor_params_id=KalturaNotImplemented, force_proxy=false) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'flavorParamsId', flavor_params_id) client.add_param(kparams, 'forceProxy', force_proxy) client.queue_service_action_call('document_documents', 'serveByFlavorParamsId', 'file', kparams) return client.get_serve_url() end
Update document entry. Only the properties that were set will be updated. @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 647 def update(entry_id, document_entry) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'documentEntry', document_entry) client.queue_service_action_call('document_documents', 'update', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Replace content associated with the given document entry. @return [KalturaDocumentEntry]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 660 def update_content(entry_id, resource, conversion_profile_id=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'entryId', entry_id) client.add_param(kparams, 'resource', resource) client.add_param(kparams, 'conversionProfileId', conversion_profile_id) client.queue_service_action_call('document_documents', 'updateContent', 'KalturaDocumentEntry', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Upload a document file to Kaltura
, then the file can be used to create a document entry. @return [string]
# File lib/kaltura_plugins/kaltura_document_client_plugin.rb, line 674 def upload(file_data) kparams = {} kfiles = {} client.add_param(kfiles, 'fileData', file_data) client.queue_service_action_call('document_documents', 'upload', 'string', kparams, kfiles) if (client.is_multirequest) return nil end return client.do_queue() end