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.



4169
4170
4171
 
# File 'lib/kaltura_client.rb', line 4169

def initialize(client)
  super(client)
end

Instance Method Details

#external_login(search_source, user_name, password) ⇒ KalturaSearchAuthData

Returns:



4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
 
# File 'lib/kaltura_client.rb', line 4174

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:



4189
4190
4191
4192
4193
4194
4195
4196
4197
 
# File 'lib/kaltura_client.rb', line 4189

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:



4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
 
# File 'lib/kaltura_client.rb', line 4201

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:



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

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