Class: Kaltura::KalturaWidgetService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

widget service for full widget management

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaWidgetService 



5733
5734
5735
 
# File 'lib/kaltura_client.rb', line 5733

def initialize(client)
  super(client)
end

Instance Method Details

#add(widget) ⇒ KalturaWidget

Add new widget, can be attached to entry or kshow SourceWidget is ignored.



5740
5741
5742
5743
5744
5745
5746
5747
5748
 
# File 'lib/kaltura_client.rb', line 5740

def add(widget)
  kparams = {}
  client.add_param(kparams, 'widget', widget)
  client.queue_service_action_call('widget', 'add', 'KalturaWidget', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#clone(widget) ⇒ KalturaWidget

Add widget based on existing widget. Must provide valid sourceWidgetId



5753
5754
5755
5756
5757
5758
5759
5760
5761
 
# File 'lib/kaltura_client.rb', line 5753

def clone(widget)
  kparams = {}
  client.add_param(kparams, 'widget', widget)
  client.queue_service_action_call('widget', 'clone', 'KalturaWidget', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(id) ⇒ KalturaWidget

Get widget by id



5765
5766
5767
5768
5769
5770
5771
5772
5773
 
# File 'lib/kaltura_client.rb', line 5765

def get(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('widget', 'get', 'KalturaWidget', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

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

Retrieve a list of available widget depends on the filter given



5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
 
# File 'lib/kaltura_client.rb', line 5777

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'filter', filter)
  client.add_param(kparams, 'pager', pager)
  client.queue_service_action_call('widget', 'list', 'KalturaWidgetListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#update(id, widget) ⇒ KalturaWidget

Update existing widget



5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
 
# File 'lib/kaltura_client.rb', line 5790

def update(id, widget)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'widget', widget)
  client.queue_service_action_call('widget', 'update', 'KalturaWidget', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end