class Kaltura::KalturaShortLinkService

Short link service

Public Class Methods

new(client) click to toggle source
Calls superclass method Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 233
def initialize(client)
        super(client)
end

Public Instance Methods

add(short_link) click to toggle source

Allows you to add a short link object @return [KalturaShortLink]

# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 239
def add(short_link)
        kparams = {}
        client.add_param(kparams, 'shortLink', short_link)
        client.queue_service_action_call('shortlink_shortlink', 'add', 'KalturaShortLink', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
delete(id) click to toggle source

Mark the short link as deleted @return [KalturaShortLink]

# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 251
def delete(id)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.queue_service_action_call('shortlink_shortlink', 'delete', 'KalturaShortLink', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get(id) click to toggle source

Retrieve an short link object by id @return [KalturaShortLink]

# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 263
def get(id)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.queue_service_action_call('shortlink_shortlink', 'get', 'KalturaShortLink', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
goto(id, proxy=false) click to toggle source

Serves short link @return [file]

# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 275
def goto(id, proxy=false)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'proxy', proxy)
        client.queue_service_action_call('shortlink_shortlink', 'goto', 'file', kparams)
        return client.get_serve_url()
end
list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

List short link objects by filter and pager @return [KalturaShortLinkListResponse]

# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 285
def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('shortlink_shortlink', 'list', 'KalturaShortLinkListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update(id, short_link) click to toggle source

Update existing short link @return [KalturaShortLink]

# File lib/kaltura_plugins/kaltura_short_link_client_plugin.rb, line 298
def update(id, short_link)
        kparams = {}
        client.add_param(kparams, 'id', id)
        client.add_param(kparams, 'shortLink', short_link)
        client.queue_service_action_call('shortlink_shortlink', 'update', 'KalturaShortLink', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end