Class: Kaltura::KalturaSearchService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

Search service allows you to search for media in various media providers

This service is being used mostly by the CW component

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaSearchService

Returns a new instance of KalturaSearchService.



3970
3971
3972
 
# File 'lib/kaltura_client.rb', line 3970

def initialize(client)
	super(client)
end

Instance Method Details

#external_login(search_source, user_name, password) ⇒ Object 



4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
 
# File 'lib/kaltura_client.rb', line 4015

def (search_source, user_name, password)
	kparams = {}
	client.add_param(kparams, 'searchSource', search_source)
	client.add_param(kparams, 'userName', user_name)
	client.add_param(kparams, 'password', password)
	client.queue_service_action_call('search', 'externalLogin', 'KalturaSearchAuthData', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_media_info(search_result) ⇒ Object

Retrieve extra information about media found in search action Some providers return only part of the fields needed to create entry from, use this action to get the rest of the fields.



3990
3991
3992
3993
3994
3995
3996
3997
3998
 
# File 'lib/kaltura_client.rb', line 3990

def get_media_info(search_result)
	kparams = {}
	client.add_param(kparams, 'searchResult', search_result)
	client.queue_service_action_call('search', 'getMediaInfo', 'KalturaSearchResult', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#search(search, pager = KalturaNotImplemented) ⇒ Object

Search for media in one of the supported media providers



3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
 
# File 'lib/kaltura_client.rb', line 3976

def search(search, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'search', search)
	client.add_param(kparams, 'pager', pager)
	client.queue_service_action_call('search', 'search', 'KalturaSearchResultResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#search_url(media_type, url) ⇒ Object

Search for media given a specific URL Kaltura supports a searchURL action on some of the media providers. This action will return a KalturaSearchResult object based on a given URL (assuming the media provider is supported)



4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
 
# File 'lib/kaltura_client.rb', line 4004

def search_url(media_type, url)
	kparams = {}
	client.add_param(kparams, 'mediaType', media_type)
	client.add_param(kparams, 'url', url)
	client.queue_service_action_call('search', 'searchUrl', 'KalturaSearchResult', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end