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.



5151
5152
5153
 
# File 'lib/kaltura_client.rb', line 5151

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:



5157
5158
5159
5160
5161
5162
5163
5164
5165
 
# File 'lib/kaltura_client.rb', line 5157

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:



5169
5170
5171
5172
5173
5174
5175
5176
5177
 
# File 'lib/kaltura_client.rb', line 5169

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:



5181
5182
5183
5184
5185
5186
5187
5188
5189
 
# File 'lib/kaltura_client.rb', line 5181

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:



5193
5194
5195
5196
5197
5198
5199
5200
5201
 
# File 'lib/kaltura_client.rb', line 5193

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) 


5205
5206
5207
5208
5209
5210
5211
5212
 
# File 'lib/kaltura_client.rb', line 5205

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:



5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
 
# File 'lib/kaltura_client.rb', line 5216

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:



5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
 
# File 'lib/kaltura_client.rb', line 5229

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:



5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
 
# File 'lib/kaltura_client.rb', line 5242

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