Class: Kaltura::KalturaUiConfService

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

Overview

UiConf service lets you create and manage your UIConfs for the various flash components

This service is used by the KMC-ApplicationStudio

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaUiConfService

Returns a new instance of KalturaUiConfService.



5095
5096
5097
 
# File 'lib/kaltura_client.rb', line 5095

def initialize(client)
  super(client)
end

Instance Method Details

#add(ui_conf) ⇒ KalturaUiConf

UIConf Add action allows you to add a UIConf to Kaltura DB

Returns:



5101
5102
5103
5104
5105
5106
5107
5108
5109
 
# File 'lib/kaltura_client.rb', line 5101

def add(ui_conf)
  kparams = {}
  client.add_param(kparams, 'uiConf', ui_conf)
  client.queue_service_action_call('uiconf', 'add', 'KalturaUiConf', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#clone(id) ⇒ KalturaUiConf

Clone an existing UIConf

Returns:



5113
5114
5115
5116
5117
5118
5119
5120
5121
 
# File 'lib/kaltura_client.rb', line 5113

def clone(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('uiconf', 'clone', 'KalturaUiConf', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#delete(id) ⇒ Object

Delete an existing UIConf

Returns:



5125
5126
5127
5128
5129
5130
5131
5132
5133
 
# File 'lib/kaltura_client.rb', line 5125

def delete(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('uiconf', 'delete', '', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get(id) ⇒ KalturaUiConf

Retrieve a UIConf by id

Returns:



5137
5138
5139
5140
5141
5142
5143
5144
5145
 
# File 'lib/kaltura_client.rb', line 5137

def get(id)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.queue_service_action_call('uiconf', 'get', 'KalturaUiConf', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#get_available_types ⇒ array

Retrieve a list of all available versions by object type

Returns:

  • (array) 


5149
5150
5151
5152
5153
5154
5155
5156
 
# File 'lib/kaltura_client.rb', line 5149

def get_available_types()
  kparams = {}
  client.queue_service_action_call('uiconf', 'getAvailableTypes', 'KalturaUiConfTypeInfo', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaUiConfListResponse

Retrieve a list of available UIConfs

Returns:



5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
 
# File 'lib/kaltura_client.rb', line 5160

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'filter', filter)
  client.add_param(kparams, 'pager', pager)
  client.queue_service_action_call('uiconf', 'list', 'KalturaUiConfListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#list_templates(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaUiConfListResponse

retrieve a list of available template UIConfs

Returns:



5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
 
# File 'lib/kaltura_client.rb', line 5173

def list_templates(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
  kparams = {}
  client.add_param(kparams, 'filter', filter)
  client.add_param(kparams, 'pager', pager)
  client.queue_service_action_call('uiconf', 'listTemplates', 'KalturaUiConfListResponse', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end

#update(id, ui_conf) ⇒ KalturaUiConf

Update an existing UIConf

Returns:



5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
 
# File 'lib/kaltura_client.rb', line 5186

def update(id, ui_conf)
  kparams = {}
  client.add_param(kparams, 'id', id)
  client.add_param(kparams, 'uiConf', ui_conf)
  client.queue_service_action_call('uiconf', 'update', 'KalturaUiConf', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end