Class: Kaltura::KalturaEntryVendorTaskService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_reach_client_plugin.rb

Overview

Entry Vendor Task Service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaEntryVendorTaskService

Returns a new instance of KalturaEntryVendorTaskService.



1730
1731
1732
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1730

def initialize(client)
	super(client)
end

Instance Method Details

#abort(id, abort_reason = KalturaNotImplemented) ⇒ KalturaEntryVendorTask

Cancel entry task. will only occur for task in PENDING or PENDING_MODERATION status

Returns:



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1736

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

#add(entry_vendor_task) ⇒ KalturaEntryVendorTask

Allows you to add a entry vendor task

Returns:



1749
1750
1751
1752
1753
1754
1755
1756
1757
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1749

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(id) ⇒ KalturaEntryVendorTask

Approve entry vendor task for execution.

Returns:



1761
1762
1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1761

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

#export_to_csv(filter) ⇒ string

add batch job that sends an email with a link to download an updated CSV that contains list of users

Returns:

  • (string) 


1773
1774
1775
1776
1777
1778
1779
1780
1781
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1773

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(id) ⇒ KalturaEntryVendorTask

Extend access key in case the existing one has expired.

Returns:



1785
1786
1787
1788
1789
1790
1791
1792
1793
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1785

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

#get(id) ⇒ KalturaEntryVendorTask

Retrieve specific entry vendor task by id

Returns:



1797
1798
1799
1800
1801
1802
1803
1804
1805
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1797

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_jobs(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaEntryVendorTaskListResponse

get KalturaEntryVendorTask objects for specific vendor partner

Returns:



1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1809

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

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaEntryVendorTaskListResponse

List KalturaEntryVendorTask objects

Returns:



1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1822

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(id, reject_reason = KalturaNotImplemented) ⇒ KalturaEntryVendorTask

Reject entry vendor task for execution.

Returns:



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1835

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

#serve_csv(id) ⇒ string

Will serve a requested csv

Returns:

  • (string) 


1848
1849
1850
1851
1852
1853
1854
1855
1856
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1848

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(id, entry_vendor_task) ⇒ KalturaEntryVendorTask

Update entry vendor task. Only the properties that were set will be updated.

Returns:



1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1860

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_job(id, entry_vendor_task) ⇒ KalturaEntryVendorTask

Update entry vendor task. Only the properties that were set will be updated.

Returns:



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1873

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