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

Returns a new instance of KalturaWidgetService.



5801
5802
5803
 
# File 'lib/kaltura_client.rb', line 5801

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.

Returns:



5808
5809
5810
5811
5812
5813
5814
5815
5816
 
# File 'lib/kaltura_client.rb', line 5808

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

Returns:



5821
5822
5823
5824
5825
5826
5827
5828
5829
 
# File 'lib/kaltura_client.rb', line 5821

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

Returns:



5833
5834
5835
5836
5837
5838
5839
5840
5841
 
# File 'lib/kaltura_client.rb', line 5833

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

Returns:



5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
 
# File 'lib/kaltura_client.rb', line 5845

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

Returns:



5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
 
# File 'lib/kaltura_client.rb', line 5858

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