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.



5772
5773
5774
 
# File 'lib/kaltura_client.rb', line 5772

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:



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

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:



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

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:



5804
5805
5806
5807
5808
5809
5810
5811
5812
 
# File 'lib/kaltura_client.rb', line 5804

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:



5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
 
# File 'lib/kaltura_client.rb', line 5816

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:



5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
 
# File 'lib/kaltura_client.rb', line 5829

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