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.



4091
4092
4093
 
# File 'lib/kaltura_client.rb', line 4091

def initialize(client)
	super(client)
end

Instance Method Details

#external_login(search_source, user_name, password) ⇒ KalturaSearchAuthData

Returns:



4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
 
# File 'lib/kaltura_client.rb', line 4096

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

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.

Returns:



4111
4112
4113
4114
4115
4116
4117
4118
4119
 
# File 'lib/kaltura_client.rb', line 4111

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

Search for media in one of the supported media providers

Returns:



4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
 
# File 'lib/kaltura_client.rb', line 4123

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

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)

Returns:



4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
 
# File 'lib/kaltura_client.rb', line 4138

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