Class: Kaltura::KalturaEntryDistributionService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb

Overview

Entry Distribution service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaEntryDistributionService

Returns a new instance of KalturaEntryDistributionService.



2131
2132
2133
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2131

def initialize(client)
	super(client)
end

Instance Method Details

#add(entry_distribution) ⇒ KalturaEntryDistribution

Add new Entry Distribution

Returns:



2137
2138
2139
2140
2141
2142
2143
2144
2145
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2137

def add(entry_distribution)
	kparams = {}
	client.add_param(kparams, 'entryDistribution', entry_distribution)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'add', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(id) ⇒ Object

Delete Entry Distribution by id

Returns:



2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2149

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

#get(id) ⇒ KalturaEntryDistribution

Get Entry Distribution by id

Returns:



2161
2162
2163
2164
2165
2166
2167
2168
2169
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2161

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

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

List all distribution providers

Returns:



2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2173

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

#retry_submit(id) ⇒ KalturaEntryDistribution

Retries last submit action

Returns:



2186
2187
2188
2189
2190
2191
2192
2193
2194
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2186

def retry_submit(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'retrySubmit', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#serve_returned_data(id, action_type) ⇒ file

Serves entry distribution returned data

Returns:

  • (file) 


2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2198

def serve_returned_data(id, action_type)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'actionType', action_type)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'serveReturnedData', 'file', kparams)
	return client.get_serve_url()
end

#serve_sent_data(id, action_type) ⇒ file

Serves entry distribution sent data

Returns:

  • (file) 


2208
2209
2210
2211
2212
2213
2214
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2208

def serve_sent_data(id, action_type)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'actionType', action_type)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'serveSentData', 'file', kparams)
	return client.get_serve_url()
end

#submit_add(id, submit_when_ready = false) ⇒ KalturaEntryDistribution

Submits Entry Distribution to the remote destination

Returns:



2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2218

def submit_add(id, submit_when_ready=false)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'submitWhenReady', submit_when_ready)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'submitAdd', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#submit_delete(id) ⇒ KalturaEntryDistribution

Deletes Entry Distribution from the remote destination

Returns:



2231
2232
2233
2234
2235
2236
2237
2238
2239
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2231

def submit_delete(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'submitDelete', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#submit_fetch_report(id) ⇒ KalturaEntryDistribution

Submits Entry Distribution report request

Returns:



2243
2244
2245
2246
2247
2248
2249
2250
2251
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2243

def submit_fetch_report(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'submitFetchReport', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#submit_update(id) ⇒ KalturaEntryDistribution

Submits Entry Distribution changes to the remote destination

Returns:



2255
2256
2257
2258
2259
2260
2261
2262
2263
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2255

def submit_update(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'submitUpdate', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(id, entry_distribution) ⇒ KalturaEntryDistribution

Update Entry Distribution by id

Returns:



2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2267

def update(id, entry_distribution)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'entryDistribution', entry_distribution)
	client.queue_service_action_call('contentdistribution_entrydistribution', 'update', 'KalturaEntryDistribution', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#validate(id) ⇒ KalturaEntryDistribution

Validates Entry Distribution by id for submission

Returns:



2280
2281
2282
2283
2284
2285
2286
2287
2288
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2280

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