Class: Kaltura::KalturaMetadataService

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

Overview

Metadata service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaMetadataService

Returns a new instance of KalturaMetadataService.



822
823
824
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 822

def initialize(client)
	super(client)
end

Instance Method Details

#add(metadata_profile_id, object_type, object_id, xml_data) ⇒ KalturaMetadata

Allows you to add a metadata object and metadata content associated with Kaltura object

Returns:



828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 828

def add(metadata_profile_id, object_type, object_id, xml_data)
	kparams = {}
	client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
	client.add_param(kparams, 'objectType', object_type)
	client.add_param(kparams, 'objectId', object_id)
	client.add_param(kparams, 'xmlData', xml_data)
	client.queue_service_action_call('metadata_metadata', 'add', 'KalturaMetadata', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#add_from_bulk(metadata_profile_id, object_type, object_id, url) ⇒ KalturaMetadata

Allows you to add a metadata XML data from remote URL. Enables different permissions than addFromUrl action.

Returns:



844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 844

def add_from_bulk(metadata_profile_id, object_type, object_id, url)
	kparams = {}
	client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
	client.add_param(kparams, 'objectType', object_type)
	client.add_param(kparams, 'objectId', object_id)
	client.add_param(kparams, 'url', url)
	client.queue_service_action_call('metadata_metadata', 'addFromBulk', 'KalturaMetadata', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#add_from_file(metadata_profile_id, object_type, object_id, xml_file) ⇒ KalturaMetadata

Allows you to add a metadata object and metadata file associated with Kaltura object

Returns:



859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 859

def add_from_file(metadata_profile_id, object_type, object_id, xml_file)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
	client.add_param(kparams, 'objectType', object_type)
	client.add_param(kparams, 'objectId', object_id)
	client.add_param(kfiles, 'xmlFile', xml_file)
	client.queue_service_action_call('metadata_metadata', 'addFromFile', 'KalturaMetadata', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#add_from_url(metadata_profile_id, object_type, object_id, url) ⇒ KalturaMetadata

Allows you to add a metadata XML data from remote URL

Returns:



875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 875

def add_from_url(metadata_profile_id, object_type, object_id, url)
	kparams = {}
	client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
	client.add_param(kparams, 'objectType', object_type)
	client.add_param(kparams, 'objectId', object_id)
	client.add_param(kparams, 'url', url)
	client.queue_service_action_call('metadata_metadata', 'addFromUrl', 'KalturaMetadata', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(id) ⇒ Object

Delete an existing metadata

Returns:



890
891
892
893
894
895
896
897
898
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 890

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

#get(id) ⇒ KalturaMetadata

Retrieve a metadata object by id

Returns:



902
903
904
905
906
907
908
909
910
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 902

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

#index(id, should_update) ⇒ int

Index metadata by id, will also index the related object

Returns:

  • (int) 


914
915
916
917
918
919
920
921
922
923
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 914

def index(id, should_update)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'shouldUpdate', should_update)
	client.queue_service_action_call('metadata_metadata', 'index', 'int', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#invalidate(id, version = KalturaNotImplemented) ⇒ Object

Mark existing metadata as invalid Used by batch metadata transform

Returns:



928
929
930
931
932
933
934
935
936
937
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 928

def invalidate(id, version=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'version', version)
	client.queue_service_action_call('metadata_metadata', 'invalidate', '', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

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

List metadata objects by filter and pager

Returns:



941
942
943
944
945
946
947
948
949
950
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 941

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

#serve(id) ⇒ file

Serves metadata XML file

Returns:

  • (file) 


954
955
956
957
958
959
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 954

def serve(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('metadata_metadata', 'serve', 'file', kparams)
	return client.get_serve_url()
end

#update(id, xml_data = KalturaNotImplemented, version = KalturaNotImplemented) ⇒ KalturaMetadata

Update an existing metadata object with new XML content

Returns:



963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 963

def update(id, xml_data=KalturaNotImplemented, version=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'xmlData', xml_data)
	client.add_param(kparams, 'version', version)
	client.queue_service_action_call('metadata_metadata', 'update', 'KalturaMetadata', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_from_file(id, xml_file = KalturaNotImplemented) ⇒ KalturaMetadata

Update an existing metadata object with new XML file

Returns:



977
978
979
980
981
982
983
984
985
986
987
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 977

def update_from_file(id, xml_file=KalturaNotImplemented)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kfiles, 'xmlFile', xml_file)
	client.queue_service_action_call('metadata_metadata', 'updateFromFile', 'KalturaMetadata', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_from_xsl(id, xsl_file) ⇒ KalturaMetadata

Action transforms current metadata object XML using a provided XSL.

Returns:



991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 991

def update_from_xsl(id, xsl_file)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kfiles, 'xslFile', xsl_file)
	client.queue_service_action_call('metadata_metadata', 'updateFromXSL', 'KalturaMetadata', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end