Class: Kaltura::KalturaMetadataProfileService

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

Overview

Metadata Profile service

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaMetadataProfileService

Returns a new instance of KalturaMetadataProfileService.



1007
1008
1009
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1007

def initialize(client)
	super(client)
end

Instance Method Details

#add(metadata_profile, xsd_data, views_data = KalturaNotImplemented) ⇒ KalturaMetadataProfile

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

Returns:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1013

def add(metadata_profile, xsd_data, views_data=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'metadataProfile', metadata_profile)
	client.add_param(kparams, 'xsdData', xsd_data)
	client.add_param(kparams, 'viewsData', views_data)
	client.queue_service_action_call('metadata_metadataprofile', 'add', 'KalturaMetadataProfile', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#add_from_file(metadata_profile, xsd_file, views_file = KalturaNotImplemented) ⇒ KalturaMetadataProfile

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

Returns:



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1027

def add_from_file(metadata_profile, xsd_file, views_file=KalturaNotImplemented)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'metadataProfile', metadata_profile)
	client.add_param(kfiles, 'xsdFile', xsd_file)
	client.add_param(kfiles, 'viewsFile', views_file)
	client.queue_service_action_call('metadata_metadataprofile', 'addFromFile', 'KalturaMetadataProfile', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#delete(id) ⇒ Object

Delete an existing metadata profile

Returns:



1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1042

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

#get(id) ⇒ KalturaMetadataProfile

Retrieve a metadata profile object by id

Returns:



1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1054

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

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

List metadata profile objects by filter and pager

Returns:



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1066

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_metadataprofile', 'list', 'KalturaMetadataProfileListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#list_fields(metadata_profile_id) ⇒ KalturaMetadataProfileFieldListResponse

List metadata profile fields by metadata profile id

Returns:



1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1079

def list_fields(metadata_profile_id)
	kparams = {}
	client.add_param(kparams, 'metadataProfileId', metadata_profile_id)
	client.queue_service_action_call('metadata_metadataprofile', 'listFields', 'KalturaMetadataProfileFieldListResponse', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#revert(id, to_version) ⇒ KalturaMetadataProfile

Update an existing metadata object definition file

Returns:



1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1091

def revert(id, to_version)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'toVersion', to_version)
	client.queue_service_action_call('metadata_metadataprofile', 'revert', 'KalturaMetadataProfile', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#serve(id) ⇒ file

Serves metadata profile XSD file

Returns:

  • (file) 


1104
1105
1106
1107
1108
1109
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1104

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

#serve_view(id) ⇒ file

Serves metadata profile view file

Returns:

  • (file) 


1113
1114
1115
1116
1117
1118
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1113

def serve_view(id)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.queue_service_action_call('metadata_metadataprofile', 'serveView', 'file', kparams)
	return client.get_serve_url()
end

#update(id, metadata_profile, xsd_data = KalturaNotImplemented, views_data = KalturaNotImplemented) ⇒ KalturaMetadataProfile

Update an existing metadata object

Returns:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1122

def update(id, metadata_profile, xsd_data=KalturaNotImplemented, views_data=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kparams, 'metadataProfile', metadata_profile)
	client.add_param(kparams, 'xsdData', xsd_data)
	client.add_param(kparams, 'viewsData', views_data)
	client.queue_service_action_call('metadata_metadataprofile', 'update', 'KalturaMetadataProfile', kparams)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_definition_from_file(id, xsd_file) ⇒ KalturaMetadataProfile

Update an existing metadata object definition file

Returns:



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1137

def update_definition_from_file(id, xsd_file)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kfiles, 'xsdFile', xsd_file)
	client.queue_service_action_call('metadata_metadataprofile', 'updateDefinitionFromFile', 'KalturaMetadataProfile', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_transformation_from_file(id, xslt_file) ⇒ KalturaMetadataProfile

Update an existing metadata object XSLT file

Returns:



1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1151

def update_transformation_from_file(id, xslt_file)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kfiles, 'xsltFile', xslt_file)
	client.queue_service_action_call('metadata_metadataprofile', 'updateTransformationFromFile', 'KalturaMetadataProfile', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end

#update_views_from_file(id, views_file) ⇒ KalturaMetadataProfile

Update an existing metadata object views file

Returns:



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'lib/kaltura_plugins/kaltura_metadata_client_plugin.rb', line 1165

def update_views_from_file(id, views_file)
	kparams = {}
	kfiles = {}
	client.add_param(kparams, 'id', id)
	client.add_param(kfiles, 'viewsFile', views_file)
	client.queue_service_action_call('metadata_metadataprofile', 'updateViewsFromFile', 'KalturaMetadataProfile', kparams, kfiles)
	if (client.is_multirequest)
		return nil
	end
	return client.do_queue()
end