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.



5857
5858
5859
 
# File 'lib/kaltura_client.rb', line 5857

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:



5864
5865
5866
5867
5868
5869
5870
5871
5872
 
# File 'lib/kaltura_client.rb', line 5864

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:



5877
5878
5879
5880
5881
5882
5883
5884
5885
 
# File 'lib/kaltura_client.rb', line 5877

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:



5889
5890
5891
5892
5893
5894
5895
5896
5897
 
# File 'lib/kaltura_client.rb', line 5889

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:



5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
 
# File 'lib/kaltura_client.rb', line 5901

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:



5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
 
# File 'lib/kaltura_client.rb', line 5914

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