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.



4115
4116
4117
 
# File 'lib/kaltura_client.rb', line 4115

def initialize(client)
  super(client)
end

Instance Method Details

#external_login(search_source, user_name, password) ⇒ KalturaSearchAuthData

Returns:



4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
 
# File 'lib/kaltura_client.rb', line 4120

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:



4135
4136
4137
4138
4139
4140
4141
4142
4143
 
# File 'lib/kaltura_client.rb', line 4135

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:



4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
 
# File 'lib/kaltura_client.rb', line 4147

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:



4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
 
# File 'lib/kaltura_client.rb', line 4162

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