Class: Kaltura::KalturaDistributionFieldConfig

Inherits:
KalturaObjectBase show all
Defined in:
lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb

Instance Attribute Summary collapse

Attributes inherited from KalturaObjectBase

#object_type, #related_objects

Instance Method Summary collapse

Methods inherited from KalturaObjectBase

#camelcase, #to_b, #to_params

Instance Attribute Details

#entry_mrss_xslt ⇒ Object

An XSLT string that extracts the right value from the Kaltura entry MRSS XML.

The value of the current connector field will be the one that is returned from transforming the Kaltura entry MRSS XML using this XSLT string.



231
232
233
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 231

def entry_mrss_xslt
  @entry_mrss_xslt
end

#field_name ⇒ Object

A value taken from a connector field enum which associates the current configuration to that connector field

Field enum class should be returned by the provider's getFieldEnumClass function.



224
225
226
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 224

def field_name
  @field_name
end

#is_default ⇒ Object

Is this field config is the default for the distribution provider?



243
244
245
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 243

def is_default
  @is_default
end

#is_required ⇒ Object

Is the field required to have a value for submission ?



234
235
236
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 234

def is_required
  @is_required
end

#trigger_delete_on_error ⇒ Object

Is an error on this field going to trigger deletion of distributed content?



246
247
248
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 246

def trigger_delete_on_error
  @trigger_delete_on_error
end

#update_on_change ⇒ Object

Trigger distribution update when this field changes or not ?



237
238
239
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 237

def update_on_change
  @update_on_change
end

#update_params ⇒ Object

Entry column or metadata xpath that should trigger an update



240
241
242
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 240

def update_params
  @update_params
end

#user_friendly_field_name ⇒ Object

A string that will be shown to the user as the field name in error messages related to the current field



227
228
229
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 227

def user_friendly_field_name
  @user_friendly_field_name
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 261

def from_xml(xml_element)
	super
	self.field_name = xml_element.elements['fieldName'].text
	self.user_friendly_field_name = xml_element.elements['userFriendlyFieldName'].text
	self.entry_mrss_xslt = xml_element.elements['entryMrssXslt'].text
	self.is_required = xml_element.elements['isRequired'].text
	self.update_on_change = xml_element.elements['updateOnChange'].text
	self.update_params = KalturaClientBase.object_from_xml(xml_element.elements['updateParams'], 'KalturaString')
	self.is_default = xml_element.elements['isDefault'].text
	self.trigger_delete_on_error = xml_element.elements['triggerDeleteOnError'].text
end