class Kaltura::KalturaMetadataService

Metadata service

Public Class Methods

new(client) click to toggle source
Calls superclass method Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 823
def initialize(client)
        super(client)
end

Public Instance Methods

add(metadata_profile_id, object_type, object_id, xml_data) click to toggle source

Allows you to add a metadata object and metadata content associated with Kaltura object @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 829
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) click to toggle source

Allows you to add a metadata XML data from remote URL.

Enables different permissions than addFromUrl action.

@return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 845
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) click to toggle source

Allows you to add a metadata object and metadata file associated with Kaltura object @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 860
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) click to toggle source

Allows you to add a metadata XML data from remote URL @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 876
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) click to toggle source

Delete an existing metadata @return []

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 891
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) click to toggle source

Retrieve a metadata object by id @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 903
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) click to toggle source

Index metadata by id, will also index the related object @return [int]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 915
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) click to toggle source

Mark existing metadata as invalid

Used by batch metadata transform

@return []

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 929
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) click to toggle source

List metadata objects by filter and pager @return [KalturaMetadataListResponse]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 942
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) click to toggle source

Serves metadata XML file @return [file]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 955
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) click to toggle source

Update an existing metadata object with new XML content @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 964
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) click to toggle source

Update an existing metadata object with new XML file @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 978
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) click to toggle source

Action transforms current metadata object XML using a provided XSL. @return [KalturaMetadata]

# File lib/kaltura_plugins/kaltura_metadata_client_plugin.rb, line 992
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