class Contentful::Management::UIExtension
Resource
class for UIExtension
. @see _ www.contentful.com/developers/docs/references/content-management-api/#/reference/ui-extensions
Public Class Methods
Source
# File lib/contentful/management/ui_extension.rb, line 24 def self.create_attributes(_client, attributes) extension = attributes['extension'] || attributes[:extension] fail 'Invalid UI Extension attributes' unless valid_extension?(extension) { 'extension' => extension } end
@private
Source
# File lib/contentful/management/ui_extension.rb, line 19 def self.endpoint 'extensions' end
@private
Source
# File lib/contentful/management/ui_extension.rb, line 33 def self.valid_extension?(extension) return false unless extension.key?('name') return false unless extension.key?('fieldTypes') && extension['fieldTypes'].is_a?(::Array) return false unless extension.key?('src') || extension.key?('srcdoc') return false if extension.key?('sidebar') && ![false, true].include?(extension['sidebar']) true end
@private
Public Instance Methods
Source
# File lib/contentful/management/ui_extension.rb, line 66 def field_types extension['fieldTypes'] end
Returns extension field types @return [Array<String>] field types
Source
# File lib/contentful/management/ui_extension.rb, line 72 def field_types=(values) extension['fieldTypes'] = values end
Sets extension field types @param [Array<String>] values
Source
# File lib/contentful/management/ui_extension.rb, line 54 def name extension['name'] end
Returns extension name @return [String] name
Source
# File lib/contentful/management/ui_extension.rb, line 60 def name=(value) extension['name'] = value end
Sets extension name @param [String] value
Source
# File lib/contentful/management/ui_extension.rb, line 108 def parameters extension['parameters'] end
Returns extensions parameters @return [Hash] parameters
Source
# File lib/contentful/management/ui_extension.rb, line 114 def parameters=(value) extension['parameters'] = value end
Sets extension parameters @param [Hash] value
Source
# File lib/contentful/management/ui_extension.rb, line 46 def save fail 'Invalid UI extension attributes' unless self.class.valid_extension?(extension) update(extension: extension) end
If an extension is a new object gets created in the Contentful
, otherwise the existing extension gets updated. @see _ github.com/contentful/contentful-management.rb for details.
@return [Contentful::Management::UIExtension]
Source
# File lib/contentful/management/ui_extension.rb, line 78 def source extension['src'] || extension['srcdoc'] end
Returns extension source URL or data @return [String] source URL or data
Source
# File lib/contentful/management/ui_extension.rb, line 84 def source=(value) if value.start_with?('http') extension['src'] = value extension.delete('srcdoc') else extension['srcdoc'] = value extension.delete('src') end end
Sets extension source @param [String] value URL or data