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.



1771
1772
1773
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1771

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:



1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1777

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:



1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1790

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:



1802
1803
1804
1805
1806
1807
1808
1809
1810
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1802

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) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1814

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:



1826
1827
1828
1829
1830
1831
1832
1833
1834
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1826

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:



1838
1839
1840
1841
1842
1843
1844
1845
1846
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1838

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:



1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1850

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:



1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1863

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:



1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1876

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) 


1889
1890
1891
1892
1893
1894
1895
1896
1897
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1889

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:



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1901

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:



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
 
# File 'lib/kaltura_plugins/kaltura_reach_client_plugin.rb', line 1914

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