Class: Kaltura::KalturaShortLinkService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_short_link_client_plugin.rb

Overview

Short link service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaShortLinkService

Returns a new instance of KalturaShortLinkService.



186
187
188
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 186

def initialize(client)
  super(client)
end

Instance Method Details

#add(short_link) ⇒ Object

Allows you to add a short link object



205
206
207
208
209
210
211
212
213
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 205

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

Mark the short link as deleted



242
243
244
245
246
247
248
249
250
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 242

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

Retrieve an short link object by id



217
218
219
220
221
222
223
224
225
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 217

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

Serves short link



254
255
256
257
258
259
260
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 254

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

List short link objects by filter and pager



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 192

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

Update exisitng short link



229
230
231
232
233
234
235
236
237
238
 
# File 'lib/kaltura_plugins/kaltura_short_link_client_plugin.rb', line 229

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