class Kaltura::KalturaEntryVendorTaskService
Entry Vendor Task Service
Public Class Methods
Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1866 def initialize(client) super(client) end
Public Instance Methods
Cancel entry task. will only occur for task in PENDING or PENDING_MODERATION status @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1872 def abort(id, abort_reason=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'abortReason', abort_reason) client.queue_service_action_call('reach_entryvendortask', 'abort', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Allows you to add a entry vendor task @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1885 def add(entry_vendor_task) kparams = {} client.add_param(kparams, 'entryVendorTask', entry_vendor_task) client.queue_service_action_call('reach_entryvendortask', 'add', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Approve entry vendor task for execution. @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1897 def approve(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('reach_entryvendortask', 'approve', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
add batch job that sends an email with a link to download an updated CSV that contains list of users @return [string]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1909 def export_to_csv(filter) kparams = {} client.add_param(kparams, 'filter', filter) client.queue_service_action_call('reach_entryvendortask', 'exportToCsv', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Extend access key in case the existing one has expired. @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1921 def extend_access_key(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('reach_entryvendortask', 'extendAccessKey', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Retrieve specific entry vendor task by id @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1933 def get(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('reach_entryvendortask', 'get', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
get KalturaEntryVendorTask
objects for specific vendor partner @return [KalturaEntryVendorTaskListResponse]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1945 def get_jobs(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('reach_entryvendortask', 'getJobs', 'KalturaEntryVendorTaskListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
@return [string]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1957 def get_serve_url(filter_type=KalturaNotImplemented, filter_input=KalturaNotImplemented, status=KalturaNotImplemented, due_date=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filterType', filter_type) client.add_param(kparams, 'filterInput', filter_input) client.add_param(kparams, 'status', status) client.add_param(kparams, 'dueDate', due_date) client.queue_service_action_call('reach_entryvendortask', 'getServeUrl', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
List KalturaEntryVendorTask
objects @return [KalturaEntryVendorTaskListResponse]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1972 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('reach_entryvendortask', 'list', 'KalturaEntryVendorTaskListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Reject entry vendor task for execution. @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1985 def reject(id, reject_reason=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'rejectReason', reject_reason) client.queue_service_action_call('reach_entryvendortask', 'reject', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
@return [file]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 1997 def serve(vendor_partner_id=KalturaNotImplemented, partner_id=KalturaNotImplemented, status=KalturaNotImplemented, due_date=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'vendorPartnerId', vendor_partner_id) client.add_param(kparams, 'partnerId', partner_id) client.add_param(kparams, 'status', status) client.add_param(kparams, 'dueDate', due_date) client.queue_service_action_call('reach_entryvendortask', 'serve', 'file', kparams) return client.get_serve_url() end
Will serve a requested csv @return [string]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 2009 def serve_csv(id) kparams = {} client.add_param(kparams, 'id', id) client.queue_service_action_call('reach_entryvendortask', 'serveCsv', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Update entry vendor task. Only the properties that were set will be updated. @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 2021 def update(id, entry_vendor_task) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'entryVendorTask', entry_vendor_task) client.queue_service_action_call('reach_entryvendortask', 'update', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end
Update entry vendor task. Only the properties that were set will be updated. @return [KalturaEntryVendorTask]
# File lib/kaltura_plugins/kaltura_reach_client_plugin.rb, line 2034 def update_job(id, entry_vendor_task) kparams = {} client.add_param(kparams, 'id', id) client.add_param(kparams, 'entryVendorTask', entry_vendor_task) client.queue_service_action_call('reach_entryvendortask', 'updateJob', 'KalturaEntryVendorTask', kparams) if (client.is_multirequest) return nil end return client.do_queue() end