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.



2124
2125
2126
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2124

def initialize(client)
  super(client)
end

Instance Method Details

#add(entry_distribution) ⇒ KalturaEntryDistribution

Add new Entry Distribution

Returns:



2130
2131
2132
2133
2134
2135
2136
2137
2138
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2130

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:



2142
2143
2144
2145
2146
2147
2148
2149
2150
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2142

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:



2154
2155
2156
2157
2158
2159
2160
2161
2162
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2154

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:



2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2166

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:



2179
2180
2181
2182
2183
2184
2185
2186
2187
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2179

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) 


2191
2192
2193
2194
2195
2196
2197
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2191

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) 


2201
2202
2203
2204
2205
2206
2207
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2201

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:



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2211

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:



2224
2225
2226
2227
2228
2229
2230
2231
2232
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2224

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:



2236
2237
2238
2239
2240
2241
2242
2243
2244
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2236

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:



2248
2249
2250
2251
2252
2253
2254
2255
2256
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2248

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:



2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2260

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:



2273
2274
2275
2276
2277
2278
2279
2280
2281
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 2273

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