class Kaltura::KalturaWidgetService

widget service for full widget management

Public Class Methods

new(client) click to toggle source
Calls superclass method
# File lib/kaltura_client.rb, line 5816
def initialize(client)
        super(client)
end

Public Instance Methods

add(widget) click to toggle source

Add new widget, can be attached to entry or kshow

SourceWidget is ignored.

@return [KalturaWidget]

# File lib/kaltura_client.rb, line 5823
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) click to toggle source

Add widget based on existing widget.

Must provide valid sourceWidgetId

@return [KalturaWidget]

# File lib/kaltura_client.rb, line 5836
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) click to toggle source

Get widget by id @return [KalturaWidget]

# File lib/kaltura_client.rb, line 5848
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) click to toggle source

Retrieve a list of available widget depends on the filter given @return [KalturaWidgetListResponse]

# File lib/kaltura_client.rb, line 5860
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) click to toggle source

Update existing widget @return [KalturaWidget]

# File lib/kaltura_client.rb, line 5873
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