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.



4210
4211
4212
 
# File 'lib/kaltura_client.rb', line 4210

def initialize(client)
  super(client)
end

Instance Method Details

#external_login(search_source, user_name, password) ⇒ KalturaSearchAuthData

Returns:



4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
 
# File 'lib/kaltura_client.rb', line 4215

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:



4230
4231
4232
4233
4234
4235
4236
4237
4238
 
# File 'lib/kaltura_client.rb', line 4230

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:



4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
 
# File 'lib/kaltura_client.rb', line 4242

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:



4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/kaltura_client.rb', line 4257

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