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.



5168
5169
5170
 
# File 'lib/kaltura_client.rb', line 5168

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:



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

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:



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

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:



5198
5199
5200
5201
5202
5203
5204
5205
5206
 
# File 'lib/kaltura_client.rb', line 5198

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:



5210
5211
5212
5213
5214
5215
5216
5217
5218
 
# File 'lib/kaltura_client.rb', line 5210

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) 


5222
5223
5224
5225
5226
5227
5228
5229
 
# File 'lib/kaltura_client.rb', line 5222

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:



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
 
# File 'lib/kaltura_client.rb', line 5233

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:



5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
 
# File 'lib/kaltura_client.rb', line 5246

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:



5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
 
# File 'lib/kaltura_client.rb', line 5259

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