Class: Kaltura::KalturaBeaconService

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

Overview

Sending beacons on objects

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaBeaconService

Returns a new instance of KalturaBeaconService.



291
292
293
 
# File 'lib/kaltura_plugins/kaltura_beacon_client_plugin.rb', line 291

def initialize(client)
	super(client)
end

Instance Method Details

#add(beacon, should_log = 0) ⇒ bool

Returns:

  • (bool) 


296
297
298
299
300
301
302
303
304
305
 
# File 'lib/kaltura_plugins/kaltura_beacon_client_plugin.rb', line 296

def add(beacon, should_log=0)
	kparams = {}
	client.add_param(kparams, 'beacon', beacon)
	client.add_param(kparams, 'shouldLog', should_log)
	client.queue_service_action_call('beacon_beacon', 'add', 'bool', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#enhance_search(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaBeaconListResponse

Returns:



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/kaltura_plugins/kaltura_beacon_client_plugin.rb', line 308

def enhance_search(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('beacon_beacon', 'enhanceSearch', 'KalturaBeaconListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaBeaconListResponse

Returns:



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/kaltura_plugins/kaltura_beacon_client_plugin.rb', line 320

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('beacon_beacon', 'list', 'KalturaBeaconListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#search_scheduled_resource(search_params, pager = KalturaNotImplemented) ⇒ KalturaBeaconListResponse

Returns:



332
333
334
335
336
337
338
339
340
341
 
# File 'lib/kaltura_plugins/kaltura_beacon_client_plugin.rb', line 332

def search_scheduled_resource(search_params, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'searchParams', search_params)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('beacon_beacon', 'searchScheduledResource', 'KalturaBeaconListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end