Class: Zernio::FacebookSettings

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/facebook_settings.rb

Overview

Facebook options that must be nested under platformSpecificData.facebookSettings, or sent at the request root as facebookSettings. The remaining Facebook options sit directly on platformSpecificData, see FacebookPlatformData.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ FacebookSettings

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::FacebookSettings` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::FacebookSettings`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'draft')
    self.draft = attributes[:'draft']
  else
    self.draft = false
  end

  if attributes.key?(:'carousel_cards')
    if (value = attributes[:'carousel_cards']).is_a?(Array)
      self.carousel_cards = value
    end
  end

  if attributes.key?(:'carousel_link')
    self.carousel_link = attributes[:'carousel_link']
  end

  if attributes.key?(:'text_format_preset_id')
    self.text_format_preset_id = attributes[:'text_format_preset_id']
  end
end

Instance Attribute Details

Renders the post as a multi-link carousel (organic Page post). When set, mediaItems must be provided with the same length and all items must be images (no videos). Each cards adds the click-through link and headline for the image at mediaItems. Mutually exclusive with contentType=story|reel. Facebook display truncates name at ~35 chars and description at ~30 chars; longer strings are accepted but get truncated on render.



23
24
25
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 23

def carousel_cards
  @carousel_cards
end

#carousel_link ⇒ Object

Optional top-level "See more" destination shown on the carousel end card. Defaults to the first card's link when omitted. Only used together with carouselCards.



26
27
28
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 26

def carousel_link
  @carousel_link
end

#draft ⇒ Object

When true, creates the post as a draft in Facebook Publishing Tools instead of publishing immediately. Supported for feed posts (text, link, image, video) and reels. Not supported for stories. Drafts expire after ~30 days.



20
21
22
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 20

def draft
  @draft
end

#text_format_preset_id ⇒ Object

Facebook-defined preset ID that renders the post as large text on a colored background (Graph text_format_preset_id). Supply the raw numeric ID from Meta; we do not publish a catalog of presets and Facebook may change the available set. Pages only (ignored on personal profiles and groups) and text-only feed posts only: the request is rejected with 400 when mediaItems or carouselCards are present, when contentType is story or reel, or when content is empty. An attachment makes Facebook drop the background silently, so those are rejected up front. Length is NOT rejected: Facebook's composer stops offering a background at around 130 characters, but Meta documents no API limit, so longer content publishes and returns a warning instead. A URL detected in the content is NOT attached as a link preview while a preset is set, because a link attachment also makes Facebook drop the background.



29
30
31
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 29

def text_format_preset_id
  @text_format_preset_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



32
33
34
35
36
37
38
39
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 32

def self.attribute_map
  {
    :'draft' => :'draft',
    :'carousel_cards' => :'carouselCards',
    :'carousel_link' => :'carouselLink',
    :'text_format_preset_id' => :'textFormatPresetId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 194

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 62

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 52

def self.openapi_types
  {
    :'draft' => :'Boolean',
    :'carousel_cards' => :'Array<FacebookSettingsCarouselCardsInner>',
    :'carousel_link' => :'String',
    :'text_format_preset_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      draft == o.draft &&
      carousel_cards == o.carousel_cards &&
      carousel_link == o.carousel_link &&
      text_format_preset_id == o.text_format_preset_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


181
182
183
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



187
188
189
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 187

def hash
  [draft, carousel_cards, carousel_link, text_format_preset_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 106

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@carousel_cards.nil? && @carousel_cards.length > 5
    invalid_properties.push('invalid value for "carousel_cards", number of items must be less than or equal to 5.')
  end

  if !@carousel_cards.nil? && @carousel_cards.length < 2
    invalid_properties.push('invalid value for "carousel_cards", number of items must be greater than or equal to 2.')
  end

  pattern = Regexp.new(/^\d+$/)
  if !@text_format_preset_id.nil? && @text_format_preset_id !~ pattern
    invalid_properties.push("invalid value for \"text_format_preset_id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 216

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
131
132
133
 
# File 'lib/zernio-sdk/models/facebook_settings.rb', line 127

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@carousel_cards.nil? && @carousel_cards.length > 5
  return false if !@carousel_cards.nil? && @carousel_cards.length < 2
  return false if !@text_format_preset_id.nil? && @text_format_preset_id !~ Regexp.new(/^\d+$/)
  true
end