Class: Kaltura::KalturaAttachmentAssetService

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

Overview

Retrieve information and invoke actions on attachment Asset

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaAttachmentAssetService

Returns a new instance of KalturaAttachmentAssetService.



157
158
159
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 157

def initialize(client)
	super(client)
end

Instance Method Details

#add(entry_id, attachment_asset) ⇒ KalturaAttachmentAsset

Add attachment asset

Returns:



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 163

def add(entry_id, attachment_asset)
	kparams = {}
	client.add_param(kparams, 'entryId', entry_id)
	client.add_param(kparams, 'attachmentAsset', attachment_asset)
	client.queue_service_action_call('attachment_attachmentasset', 'add', 'KalturaAttachmentAsset', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(attachment_asset_id) ⇒ Object

Returns [].

Returns:



175
176
177
178
179
180
181
182
183
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 175

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

#get(attachment_asset_id) ⇒ KalturaAttachmentAsset

Returns:



186
187
188
189
190
191
192
193
194
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 186

def get(attachment_asset_id)
	kparams = {}
	client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
	client.queue_service_action_call('attachment_attachmentasset', 'get', 'KalturaAttachmentAsset', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_remote_paths(id) ⇒ KalturaRemotePathListResponse

Get remote storage existing paths for the asset

Returns:



198
199
200
201
202
203
204
205
206
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 198

def get_remote_paths(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('attachment_attachmentasset', 'getRemotePaths', 'KalturaRemotePathListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#get_url(id, storage_id = KalturaNotImplemented) ⇒ string

Get download URL for the asset

Returns:

  • (string) 


210
211
212
213
214
215
216
217
218
219
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 210

def get_url(id, storage_id=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'storageId', storage_id)
	client.queue_service_action_call('attachment_attachmentasset', 'getUrl', 'string', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

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

List attachment Assets by filter and pager

Returns:



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 223

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

#serve(attachment_asset_id, serve_options = KalturaNotImplemented) ⇒ file

Serves attachment by its id

Returns:

  • (file) 


236
237
238
239
240
241
242
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 236

def serve(attachment_asset_id, serve_options=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'attachmentAssetId', attachment_asset_id)
	client.add_param(kparams, 'serveOptions', serve_options)
	client.queue_service_action_call('attachment_attachmentasset', 'serve', 'file', kparams)
	return client.get_serve_url()
end

#set_content(id, content_resource) ⇒ KalturaAttachmentAsset

Update content of attachment asset

Returns:



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 246

def set_content(id, content_resource)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'contentResource', content_resource)
	client.queue_service_action_call('attachment_attachmentasset', 'setContent', 'KalturaAttachmentAsset', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update(id, attachment_asset) ⇒ KalturaAttachmentAsset

Update attachment asset

Returns:



259
260
261
262
263
264
265
266
267
268
 
# File 'lib/kaltura_plugins/kaltura_attachment_client_plugin.rb', line 259

def update(id, attachment_asset)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'attachmentAsset', attachment_asset)
	client.queue_service_action_call('attachment_attachmentasset', 'update', 'KalturaAttachmentAsset', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end