Class: KalturaApi::KalturaWidgetService

Inherits:

KalturaServiceBase

• Object
• KalturaServiceBase
• KalturaApi::KalturaWidgetService

Defined in:

lib/kaltura_client.rb

Overview

widget service for full widget management

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary

• #add(widget) ⇒ Object

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

• #clone(widget) ⇒ Object

  Add widget based on existing widget.

• #get(id) ⇒ Object

  Get widget by id.

• #initialize(client) ⇒ KalturaWidgetService constructor

  A new instance of KalturaWidgetService.

• #list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

  Retrieve a list of available widget depends on the filter given.

• #update(id, widget) ⇒ Object

  Update exisiting widget.

Constructor Details

#initialize(client) ⇒ KalturaWidgetService

Returns a new instance of KalturaWidgetService.

# File 'lib/kaltura_client.rb', line 14019

def initialize(client)
	super(client)
end

Instance Method Details

#add(widget) ⇒ Object

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

# File 'lib/kaltura_client.rb', line 14026

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

#clone(widget) ⇒ Object

Add widget based on existing widget. Must provide valid sourceWidgetId

# File 'lib/kaltura_client.rb', line 14064

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

#get(id) ⇒ Object

Get widget by id

# File 'lib/kaltura_client.rb', line 14051

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

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

Retrieve a list of available widget depends on the filter given

# File 'lib/kaltura_client.rb', line 14076

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', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update(id, widget) ⇒ Object

Update exisiting widget

# File 'lib/kaltura_client.rb', line 14038

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