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.



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

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.



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

def field_name
  @field_name
end

#is_default ⇒ Object

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



255
256
257
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 255

def is_default
  @is_default
end

#is_required ⇒ Object

Is the field required to have a value for submission ?



248
249
250
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 248

def is_required
  @is_required
end

#trigger_delete_on_error ⇒ Object

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



257
258
259
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 257

def trigger_delete_on_error
  @trigger_delete_on_error
end

#type ⇒ Object

Returns the value of attribute type.



249
250
251
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 249

def type
  @type
end

#update_on_change ⇒ Object

Trigger distribution update when this field changes or not ?



251
252
253
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 251

def update_on_change
  @update_on_change
end

#update_params ⇒ Object

Entry column or metadata xpath that should trigger an update



253
254
255
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 253

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



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

def user_friendly_field_name
  @user_friendly_field_name
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/kaltura_plugins/kaltura_content_distribution_client_plugin.rb', line 272

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