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.



5442
5443
5444
 
# File 'lib/kaltura_client.rb', line 5442

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.



5449
5450
5451
5452
5453
5454
5455
5456
5457
 
# File 'lib/kaltura_client.rb', line 5449

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) ⇒ Object

Add widget based on existing widget. Must provide valid sourceWidgetId



5487
5488
5489
5490
5491
5492
5493
5494
5495
 
# File 'lib/kaltura_client.rb', line 5487

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) ⇒ Object

Get widget by id



5474
5475
5476
5477
5478
5479
5480
5481
5482
 
# File 'lib/kaltura_client.rb', line 5474

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) ⇒ Object

Retrieve a list of available widget depends on the filter given



5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
 
# File 'lib/kaltura_client.rb', line 5499

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) ⇒ Object

Update exisiting widget



5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
 
# File 'lib/kaltura_client.rb', line 5461

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