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.



5699
5700
5701
 
# File 'lib/kaltura_client.rb', line 5699

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:



5706
5707
5708
5709
5710
5711
5712
5713
5714
 
# File 'lib/kaltura_client.rb', line 5706

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:



5719
5720
5721
5722
5723
5724
5725
5726
5727
 
# File 'lib/kaltura_client.rb', line 5719

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:



5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'lib/kaltura_client.rb', line 5731

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:



5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
 
# File 'lib/kaltura_client.rb', line 5743

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:



5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
 
# File 'lib/kaltura_client.rb', line 5756

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